Skip to content

docs(env): documenta ASAAS_SANDBOX (produção vs sandbox) e caveat da chave#107

Open
fabioisensee wants to merge 1 commit into
evolution-foundation:mainfrom
fabioisensee:docs/asaas-env-example
Open

docs(env): documenta ASAAS_SANDBOX (produção vs sandbox) e caveat da chave#107
fabioisensee wants to merge 1 commit into
evolution-foundation:mainfrom
fabioisensee:docs/asaas-env-example

Conversation

@fabioisensee

@fabioisensee fabioisensee commented Jun 13, 2026

Copy link
Copy Markdown

O quê

Atualiza a documentação do .env.example para a seção Asaas:

  • ASAAS_SANDBOX: explicita que "false"api.asaas.com (produção) e "true"sandbox.asaas.com (default seguro para testes).
  • Caveat da chave: a API key do Asaas começa com $ ($aact_prod_...), então não pode ser lida via source .env (o shell expande para vazio). Deve ser lida literalmente (grep | cut) — que é como a skill int-asaas monta o header access_token.

Por quê

Durante uma conciliação, o int-asaas retornou vazio porque o .env local estava com ASAAS_SANDBOX=true apesar da chave ser de produção, e uma tentativa de source .env zerou a chave (expansão do $). Esta doc evita os dois tropeços para quem configurar o ambiente.

Escopo

Apenas documentação no .env.example (sem segredos, sem código). 1 arquivo, +4/-1.

🤖 Generated with Claude Code

Summary by Sourcery

Clarify Asaas environment configuration and API key usage in the .env.example file.

Documentation:

  • Document the meaning of ASAAS_SANDBOX values for production vs sandbox endpoints in .env.example.
  • Add a note explaining that Asaas API keys starting with $ cannot be safely loaded via source .env and must be read literally.

…chave

- ASAAS_SANDBOX: "false" → api.asaas.com (produção); "true" → sandbox (default seguro)
- alerta: chave Asaas começa com "$" — não usar `source .env` (expande p/ vazio), ler literal
- arrasta docs de template pré-existentes do working tree (Gmail OAuth, containers controller_li)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@sourcery-ai

sourcery-ai Bot commented Jun 13, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the .env.example Asaas section documentation to clarify ASAAS_SANDBOX behavior (production vs sandbox endpoints) and warn about the Asaas API key starting with $ and not being safely loadable via source .env.

File-Level Changes

Change Details Files
Clarify ASAAS_SANDBOX flag semantics for Asaas environment selection.
  • Document that ASAAS_SANDBOX="false" targets api.asaas.com (production).
  • Document that ASAAS_SANDBOX="true" targets sandbox.asaas.com and is the safe default for local tests.
.env.example
Document caveat about Asaas API key starting with $ and how it must be read.
  • Explain that the Asaas API key begins with $ and will be expanded/emptied by the shell if using source .env.
  • Instruct that the key must be read literally (e.g., via grep/cut), aligning with how the int-asaas skill builds the access_token header.
.env.example

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant