Skip to main content

Usando Copilot CLI em GitHub Actions com GITHUB_TOKEN

Execute CLI do Copilot em um fluxo de trabalho GitHub Actions usando o GITHUB_TOKEN integrado, sem um personal access token.

Para obter informações sobre as opções de autenticação e como a cobrança funciona ao executar CLI do Copilot em GitHub Actions, consulte Sobre como usar Copilot CLI no GitHub Actions.

Habilitando a política

Para que os fluxos de trabalho da sua organização usem CLI do Copilot com GITHUB_TOKEN, a política deve estar habilitada. Essa política é habilitada por padrão para organizações ativadas CLI do Copilot , mas você pode confirmar ou alterar essa configuração nas configurações de política da sua organização.

  1. Navegue até as configurações de política da sua organização. Consulte Gerenciando políticas e recursos para GitHub Copilot em sua organização.
  2. Em "CLI do Copilot", confirme se Permitir o uso de CLI do Copilot cobrado da organização está selecionado.

Abordagem recomendada: GitHub Fluxos de Trabalho Agênticos

Para a maioria dos casos de uso de automação, recomendamos usar GitHub fluxos de trabalho agênticos em vez de invocar copilot diretamente nas etapas do fluxo de trabalho. Os fluxos de trabalho agênticos usam autenticação GITHUB_TOKEN por padrão e incluem salvaguardas adicionais adequadas a ambientes automatizados.

Para obter instruções de instalação, consulte Início Rápido na GitHub documentação de fluxos de trabalho do Agentic. Seu fluxo de trabalho também deve conceder a permissão copilot-requests: write. Consulte Permissões na documentação sobre GitHub fluxos de trabalho agênticos.

Usando CLI do Copilot diretamente em um fluxo de trabalho

Se você precisar invocar CLI do Copilot diretamente em uma etapa de fluxo de trabalho, instale a CLI com npm.

Aviso

Invocar CLI do Copilot diretamente em etapas de fluxo de trabalho fornece acesso amplo ao seu ambiente de fluxo de trabalho. Examine cuidadosamente os gatilhos e permissões do fluxo de trabalho antes de usar essa abordagem. Os fluxos de trabalho disparados por pull requests de forks estão particularmente em risco.

Fluxo de trabalho de exemplo

name: Copilot CLI example
on: [push]

permissions:
  contents: read
  copilot-requests: write

jobs:
  copilot:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Install Copilot CLI
        run: npm install -g @github/copilot
      - name: Run Copilot
        run: copilot --yolo -p "Summarize the changes in this commit"
        env:
          GITHUB_TOKEN: $

Principais detalhes sobre este exemplo:

  • O --yolo sinalizador suprime prompts interativos, que são necessários para ambientes não interativos, como GitHub Actions.
  • A copilot-requests: write permissão é necessária para que o fluxo de trabalho faça Copilot solicitações.
  • O GITHUB_TOKEN fornecido por GitHub Actions lida automaticamente com a autenticação; não são necessários segredos adicionais.

Observação

Você deve estar em uma versão recente de CLI do Copilot para usar a autenticação GITHUB_TOKEN. Atualize com copilot updateou reinstale a versão mais recente com npm install -g @github/copilot.