GitHub Actions
Integre o Claude Code com seus fluxos de trabalho do GitHub para revisão automatizada de código, gerenciamento de PRs e triagem de problemas.
O Claude Code GitHub Actions traz automação com IA para seu fluxo de trabalho do GitHub. Com uma simples menção @claude
em qualquer PR ou issue, o Claude pode analisar seu código, criar pull requests, implementar recursos e corrigir bugs - tudo seguindo os padrões do seu projeto.
O Claude Code GitHub Actions está atualmente em beta. Recursos e funcionalidades podem evoluir à medida que refinamos a experiência.
O Claude Code GitHub Actions é construído sobre o Claude Code SDK, que permite a integração programática do Claude Code em suas aplicações. Você pode usar o SDK para criar fluxos de trabalho de automação personalizados além do GitHub Actions.
Por que usar o Claude Code GitHub Actions?
- Criação instantânea de PRs: Descreva o que você precisa, e o Claude cria um PR completo com todas as alterações necessárias
- Implementação automatizada de código: Transforme issues em código funcional com um único comando
- Segue seus padrões: O Claude respeita suas diretrizes no
CLAUDE.md
e os padrões de código existentes - Configuração simples: Comece em minutos com nosso instalador e chave de API
- Seguro por padrão: Seu código permanece nos runners do Github
O que o Claude pode fazer?
O Claude Code fornece poderosas GitHub Actions que transformam a maneira como você trabalha com código:
Claude Code Action
Esta GitHub Action permite que você execute o Claude Code dentro dos seus fluxos de trabalho do GitHub Actions. Você pode usar isso para criar qualquer fluxo de trabalho personalizado baseado no Claude Code.
Claude Code Action (Base)
A base para construir fluxos de trabalho personalizados do GitHub com o Claude. Esta estrutura extensível oferece acesso completo às capacidades do Claude para criar automações personalizadas.
Início rápido
A maneira mais fácil de configurar esta action é através do Claude Code no terminal. Basta abrir o claude e executar /install-github-app
.
Este comando irá guiá-lo através da configuração do aplicativo GitHub e dos segredos necessários.
- Você deve ser um administrador do repositório para instalar o aplicativo GitHub e adicionar segredos
- Este método de início rápido está disponível apenas para usuários diretos da API Anthropic. Se você estiver usando AWS Bedrock ou Google Vertex AI, consulte a seção Usando com AWS Bedrock e Google Vertex AI.
Se o script de configuração falhar
Se o comando /install-github-app
falhar ou se você preferir a configuração manual, siga estas instruções de configuração manual:
- Instale o aplicativo Claude GitHub em seu repositório: https://github.com/apps/claude
- Adicione ANTHROPIC_API_KEY aos segredos do seu repositório (Saiba como usar segredos no GitHub Actions)
- Copie o arquivo de workflow de examples/claude.yml para o diretório
.github/workflows/
do seu repositório
Teste a action
Após completar a configuração rápida ou manual, teste a action marcando @claude
em um comentário de issue ou PR!
Exemplos de casos de uso
O Claude Code GitHub Actions pode ajudá-lo com uma variedade de tarefas. Para exemplos completos e funcionais, veja o diretório de exemplos.
Transforme issues em PRs
O Claude analisará a issue, escreverá o código e criará um PR para revisão.
Obtenha ajuda na implementação
O Claude analisará seu código e fornecerá orientações específicas de implementação.
Corrija bugs rapidamente
O Claude localizará o bug, implementará uma correção e criará um PR.
Melhores práticas
Configuração CLAUDE.md
Crie um arquivo CLAUDE.md
na raiz do seu repositório para definir diretrizes de estilo de código, critérios de revisão, regras específicas do projeto e padrões preferidos. Este arquivo orienta a compreensão do Claude sobre os padrões do seu projeto.
Considerações de segurança
⚠️ IMPORTANTE: Nunca comite chaves de API diretamente no seu repositório!
Sempre use GitHub Secrets para chaves de API:
- Adicione sua chave de API como um segredo do repositório chamado
ANTHROPIC_API_KEY
- Referencie-a nos workflows:
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
- Limite as permissões da action apenas ao necessário
- Revise as sugestões do Claude antes de fazer o merge
Sempre use GitHub Secrets (por exemplo, ${{ secrets.ANTHROPIC_API_KEY }}
) em vez de codificar chaves de API diretamente nos seus arquivos de workflow.
Otimizando o desempenho
Use modelos de issues para fornecer contexto, mantenha seu CLAUDE.md
conciso e focado, e configure timeouts apropriados para seus workflows.
Custos de CI
Ao usar o Claude Code GitHub Actions, esteja ciente dos custos associados:
Custos do GitHub Actions:
- O Claude Code é executado em runners hospedados pelo GitHub, que consomem seus minutos do GitHub Actions
- Veja a documentação de faturamento do GitHub para preços detalhados e limites de minutos
Custos de API:
- Cada interação com o Claude consome tokens de API com base no comprimento dos prompts e respostas
- O uso de tokens varia de acordo com a complexidade da tarefa e o tamanho da base de código
- Veja a página de preços do Claude para as taxas atuais de tokens
Dicas de otimização de custos:
- Use comandos
@claude
específicos para reduzir chamadas de API desnecessárias - Configure limites apropriados de
max_turns
para evitar iterações excessivas - Defina
timeout_minutes
razoáveis para evitar workflows descontrolados - Considere usar controles de concorrência do GitHub para limitar execuções paralelas
Exemplos de configuração
Para configurações de workflow prontas para uso em diferentes casos de uso, incluindo:
- Configuração básica de workflow para comentários em issues e PRs
- Revisões de código automatizadas em pull requests
- Implementações personalizadas para necessidades específicas
Visite o diretório de exemplos no repositório Claude Code Action.
O repositório de exemplos inclui workflows completos e testados que você pode copiar diretamente para o diretório .github/workflows/
do seu repositório.
Usando com AWS Bedrock e Google Vertex AI
Para ambientes empresariais, você pode usar o Claude Code GitHub Actions com sua própria infraestrutura na nuvem. Esta abordagem oferece controle sobre a residência de dados e faturamento, mantendo a mesma funcionalidade.
Pré-requisitos
Antes de configurar o Claude Code GitHub Actions com provedores de nuvem, você precisa:
Para Google Cloud Vertex AI:
- Um Projeto Google Cloud com Vertex AI habilitado
- Workload Identity Federation configurado para GitHub Actions
- Uma conta de serviço com as permissões necessárias
- Um aplicativo GitHub (recomendado) ou usar o GITHUB_TOKEN padrão
Para AWS Bedrock:
- Uma conta AWS com Amazon Bedrock habilitado
- Provedor de Identidade OIDC do GitHub configurado na AWS
- Uma função IAM com permissões do Bedrock
- Um aplicativo GitHub (recomendado) ou usar o GITHUB_TOKEN padrão
Criar um aplicativo GitHub personalizado (Recomendado para provedores terceirizados)
Para melhor controle e segurança ao usar provedores terceirizados como Vertex AI ou Bedrock, recomendamos criar seu próprio aplicativo GitHub:
- Acesse https://github.com/settings/apps/new
- Preencha as informações básicas:
- Nome do aplicativo GitHub: Escolha um nome único (ex: “Assistente Claude da SuaOrg”)
- URL da página inicial: O site da sua organização ou a URL do repositório
- Configure as configurações do aplicativo:
- Webhooks: Desmarque “Ativo” (não necessário para esta integração)
- Defina as permissões necessárias:
- Permissões do repositório:
- Conteúdo: Leitura e Escrita
- Issues: Leitura e Escrita
- Pull requests: Leitura e Escrita
- Permissões do repositório:
- Clique em “Criar aplicativo GitHub”
- Após a criação, clique em “Gerar uma chave privada” e salve o arquivo
.pem
baixado - Anote o ID do seu aplicativo na página de configurações do aplicativo
- Instale o aplicativo no seu repositório:
- Na página de configurações do seu aplicativo, clique em “Instalar aplicativo” na barra lateral esquerda
- Selecione sua conta ou organização
- Escolha “Apenas repositórios selecionados” e selecione o repositório específico
- Clique em “Instalar”
- Adicione a chave privada como um segredo ao seu repositório:
- Vá para Configurações do repositório → Segredos e variáveis → Actions
- Crie um novo segredo chamado
APP_PRIVATE_KEY
com o conteúdo do arquivo.pem
- Adicione o ID do aplicativo como um segredo:
- Crie um novo segredo chamado
APP_ID
com o ID do seu aplicativo GitHub
Este aplicativo será usado com a action actions/create-github-app-token para gerar tokens de autenticação em seus workflows.
Alternativa para API Anthropic ou se você não quiser configurar seu próprio aplicativo Github: Use o aplicativo oficial da Anthropic:
- Instale a partir de: https://github.com/apps/claude
- Nenhuma configuração adicional necessária para autenticação
Configurar autenticação do provedor de nuvem
Escolha seu provedor de nuvem e configure a autenticação segura:
Adicionar segredos necessários
Adicione os seguintes segredos ao seu repositório (Configurações → Segredos e variáveis → Actions):
Para API Anthropic (Direta):
-
Para autenticação de API:
ANTHROPIC_API_KEY
: Sua chave de API Anthropic de console.anthropic.com
-
Para aplicativo GitHub (se estiver usando seu próprio aplicativo):
APP_ID
: O ID do seu aplicativo GitHubAPP_PRIVATE_KEY
: O conteúdo da chave privada (.pem)
Para Google Cloud Vertex AI
-
Para autenticação GCP:
GCP_WORKLOAD_IDENTITY_PROVIDER
GCP_SERVICE_ACCOUNT
-
Para aplicativo GitHub (se estiver usando seu próprio aplicativo):
APP_ID
: O ID do seu aplicativo GitHubAPP_PRIVATE_KEY
: O conteúdo da chave privada (.pem)
Para AWS Bedrock
-
Para autenticação AWS:
AWS_ROLE_TO_ASSUME
-
Para aplicativo GitHub (se estiver usando seu próprio aplicativo):
APP_ID
: O ID do seu aplicativo GitHubAPP_PRIVATE_KEY
: O conteúdo da chave privada (.pem)
Criar arquivos de workflow
Crie arquivos de workflow do GitHub Actions que se integrem com seu provedor de nuvem. Os exemplos abaixo mostram configurações completas para AWS Bedrock e Google Vertex AI:
Solução de problemas
Claude não responde aos comandos @claude
Verifique se o aplicativo GitHub está instalado corretamente, confirme se os workflows estão habilitados, certifique-se de que a chave de API está definida nos segredos do repositório e confirme se o comentário contém @claude
(não /claude
).
CI não está sendo executado nos commits do Claude
Certifique-se de que você está usando o aplicativo GitHub ou aplicativo personalizado (não o usuário Actions), verifique se os gatilhos do workflow incluem os eventos necessários e verifique se as permissões do aplicativo incluem gatilhos de CI.
Erros de autenticação
Confirme se a chave de API é válida e tem permissões suficientes. Para Bedrock/Vertex, verifique a configuração de credenciais e certifique-se de que os segredos estão nomeados corretamente nos workflows.
Configuração avançada
Parâmetros da action
A Claude Code Action suporta estes parâmetros principais:
Parâmetro | Descrição | Obrigatório |
---|---|---|
prompt | O prompt para enviar ao Claude | Sim* |
prompt_file | Caminho para arquivo contendo o prompt | Sim* |
anthropic_api_key | Chave de API Anthropic | Sim** |
max_turns | Máximo de turnos de conversação | Não |
timeout_minutes | Timeout de execução | Não |
*Ou prompt
ou prompt_file
é obrigatório
**Obrigatório para API Anthropic direta, não para Bedrock/Vertex
Métodos alternativos de integração
Embora o comando /install-github-app
seja a abordagem recomendada, você também pode:
- Aplicativo GitHub personalizado: Para organizações que precisam de nomes de usuário personalizados ou fluxos de autenticação personalizados. Crie seu próprio aplicativo GitHub com as permissões necessárias (conteúdos, issues, pull requests) e use a action actions/create-github-app-token para gerar tokens em seus workflows.
- GitHub Actions manual: Configuração direta de workflow para máxima flexibilidade
- Configuração MCP: Carregamento dinâmico de servidores de Protocolo de Contexto de Modelo
Consulte o repositório Claude Code Action para documentação detalhada.
Personalizando o comportamento do Claude
Você pode configurar o comportamento do Claude de duas maneiras:
- CLAUDE.md: Defina padrões de codificação, critérios de revisão e regras específicas do projeto em um arquivo
CLAUDE.md
na raiz do seu repositório. O Claude seguirá essas diretrizes ao criar PRs e responder a solicitações. Confira nossa documentação de Memória para mais detalhes. - Prompts personalizados: Use o parâmetro
prompt
no arquivo de workflow para fornecer instruções específicas para o workflow. Isso permite personalizar o comportamento do Claude para diferentes workflows ou tarefas.
O Claude seguirá essas diretrizes ao criar PRs e responder a solicitações.