GITHUB_TOKEN

Saiba o que é o GITHUB_TOKEN, como ele funciona e por que é importante para a automação segura em fluxos de trabalho do GitHub Actions.

Neste artigo

Sobre o GITHUB_TOKEN

No início de cada tarefa do fluxo de trabalho, o GitHub cria automaticamente um segredo GITHUB_TOKEN exclusivo para ser usado no seu processo. Use o GITHUB_TOKEN para se autenticar em um fluxo de trabalho.

Ao habilitar GitHub Actions, GitHub instala um GitHub App no seu repositório. O segredo GITHUB_TOKEN é um token de acesso de instalação GitHub App. Você pode usar o token de acesso de instalação para autenticar em nome do GitHub App instalado no seu repositório. As permissões do token são restritas ao repositório do fluxo de trabalho. Para obter mais informações, consulte Sintaxe de fluxo de trabalho para o GitHub Actions.

Antes de cada tarefa começar, GitHub obtém um token de acesso de instalação para a tarefa. O GITHUB_TOKEN expira quando o trabalho é concluído ou após seu tempo de vida máximo efetivo.

O tempo de vida útil máximo efetivo do token depende do tipo de runner:

  •           **GitHub-hosted runners** O tempo máximo de execução do trabalho é de 6 horas; portanto, `GITHUB_TOKEN` pode durar no máximo 6 horas.
  • Executores auto-hospedados O tempo máximo de execução do trabalho é de 5 dias. No entanto, como o GITHUB_TOKEN é um token de acesso de instalação, ele só pode ser renovado por no máximo 24 horas. Se o trabalho for executado por mais de 24 horas, use um personal access token ou outro método de autenticação.

O token também está disponível no contexto github.token. Para obter mais informações, consulte Referência de contextos.

Quando GITHUB_TOKEN dispara execuções do fluxo de trabalho

Quando você usa o repositório GITHUB_TOKEN para executar tarefas, os eventos disparados pelo GITHUB_TOKEN não criarão uma nova execução de fluxo de trabalho, com a seguinte exceção:

  • Os eventos workflow_dispatch e repository_dispatch sempre criam as execuções de fluxo de trabalho.

Para todos os outros eventos, esse comportamento impede que você crie acidentalmente execuções de fluxo de trabalho recursivo. Por exemplo, se uma execução de fluxo de trabalho efetuar push do código usando o GITHUB_TOKEN do repositório, um novo fluxo de trabalho não será executado mesmo quando o repositório contiver um fluxo de trabalho configurado para ser executado quando os eventos do push ocorrerem.

Commits enviados por push por um fluxo de trabalho de GitHub Actions que usa o GITHUB_TOKEN não disparam um build de GitHub Pages.

Próximas etapas