Skip to content

Commit 5c67266

Browse files
docs: expand credentials section with costs, errors and best practices
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 6bbe205 commit 5c67266

File tree

1 file changed

+67
-9
lines changed

1 file changed

+67
-9
lines changed

claude-doc/step_command_ci_test.md

Lines changed: 67 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -137,18 +137,76 @@ if: |
137137

138138
---
139139

140-
## Fase 4 — Secrets necessários no repositório
140+
## Fase 4 — Credenciais necessárias (leia com atenção)
141141

142-
Configure em: **Settings → Secrets and variables → Actions**
142+
Esta fase é crítica. Sem as duas credenciais abaixo o workflow vai rodar e falhar
143+
silenciosamente ou com erro de autenticação. Configure **antes** de testar.
143144

144-
| Secret | Como obter | Para que serve |
145-
|--------|-----------|----------------|
146-
| `ANTHROPIC_API_KEY` | console.anthropic.com → API Keys | Autenticar chamadas à Claude API |
147-
| `GH_PAT` | github.com → Settings → Developer settings → Personal access tokens (classic) → escopo `repo` | Permitir que o workflow abra PRs |
145+
Configure em: **Settings → Secrets and variables → Actions → New repository secret**
148146

149-
> ⚠️ **Por que `GH_PAT` e não `GITHUB_TOKEN`?**
150-
> O `GITHUB_TOKEN` tem restrição de segurança que impede a criação de PRs
151-
> que poderiam disparar outros workflows. O PAT pessoal não tem essa limitação.
147+
---
148+
149+
### 🔑 `ANTHROPIC_API_KEY` — Chave da API do Claude
150+
151+
**O que é:** A chave que autentica as chamadas à Claude API. Sem ela o script
152+
não consegue chamar o modelo e nenhum teste é gerado.
153+
154+
**Como obter:**
155+
1. Acesse [console.anthropic.com](https://console.anthropic.com)
156+
2. Vá em **API Keys → Create Key**
157+
3. Copie o valor (começa com `sk-ant-...`) — ele só aparece uma vez
158+
159+
**Atenção ao saldo:**
160+
- A API é **paga por uso** — não é gratuita
161+
- Você precisa adicionar créditos em **Plans & Billing** antes de usar
162+
- Créditos **não expiram** — ficam disponíveis até serem consumidos
163+
- Com **$5** você tem de sobra para começar
164+
165+
**Custo estimado por execução:**
166+
167+
| Modelo | ~17 arquivos | ~50 arquivos |
168+
|--------|-------------|-------------|
169+
| `claude-haiku-4-5-20251001` | ~$0.09 | ~$0.25 |
170+
| `claude-opus-4-6` | ~$1.50 | ~$4.50 |
171+
172+
> Use **Haiku** para geração de testes — é ~10x mais barato e suficiente para
173+
> data classes, extension functions, DiffUtil e enums.
174+
175+
**Erro comum:** key correta mas conta sem saldo →
176+
```
177+
Your credit balance is too low to access the Anthropic API.
178+
```
179+
Solução: console.anthropic.com → Plans & Billing → Add credits.
180+
181+
---
182+
183+
### 🔑 `GH_PAT` — Personal Access Token do GitHub
184+
185+
**O que é:** Um token pessoal do GitHub que permite ao workflow abrir PRs
186+
em nome de um usuário real. Substitui o `GITHUB_TOKEN` padrão do Actions.
187+
188+
**Por que não usar `GITHUB_TOKEN`:**
189+
O `GITHUB_TOKEN` gerado automaticamente pelo Actions tem uma restrição de segurança
190+
intencional do GitHub — ele **não pode abrir PRs** que disparariam outros workflows
191+
(para evitar loops infinitos). O PAT pessoal não tem essa limitação.
192+
193+
**Como criar:**
194+
1. Acesse seu perfil no GitHub → **Settings**
195+
2. **Developer settings → Personal access tokens → Tokens (classic)**
196+
3. **Generate new token (classic)**
197+
4. Marque o escopo: `repo` (acesso completo)
198+
5. Copie o token (começa com `ghp_...`)
199+
200+
**Boas práticas:**
201+
- Dê um nome descritivo ao token (ex: `craftd-actions-bot`)
202+
- Defina uma data de expiração (90 dias é um bom equilíbrio)
203+
- Guarde o token em local seguro — o GitHub não mostra novamente
204+
205+
**Erro comum:** usar `GITHUB_TOKEN` no lugar do PAT →
206+
```
207+
refusing to allow a GitHub Actions Bot to create or approve pull requests
208+
```
209+
Solução: garantir que o step de `gh pr create` use `GH_TOKEN: ${{ secrets.GH_PAT }}`.
152210
153211
---
154212

0 commit comments

Comments
 (0)