Habilitando o log de depuração

Se os logs do fluxo de trabalho não fornecerem detalhes suficientes para diagnosticar o motivo pelo qual um fluxo de trabalho, um trabalho ou uma etapa não está funcionando como esperado, habilite o log de depuração adicional.

Neste artigo

Note

No momento, não há suporte para executores hospedados no GitHub no GitHub Enterprise Server. Você pode ver mais informações sobre o suporte futuro planejado no GitHub public roadmap.

Esses logs extras são habilitados pela definição de segredos ou variáveis no repositório que contém o fluxo de trabalho. Portanto, os mesmos requisitos de permissão são aplicáveis:

  • Para criar segredos ou variáveis no GitHub para um repositório de conta pessoal, você deve ser o proprietário do repositório. Para criar segredos no GitHub para um repositório de organização, você deve ter acesso a admin. Por fim, para criar segredos ou variáveis para um repositório de conta pessoal ou um repositório de organização por meio da API REST, você deve ter acesso de colaborador.
  • Para criar segredos ou variáveis para um ambiente em um repositório de conta pessoal, você deve ser o proprietário do repositório. Para criar segredos ou variáveis para um ambiente em um repositório da organização, é necessário ter acesso de admin. Para saber mais sobre os ambientes, confira "Gerenciar ambientes para implantação".
  • Os proprietários da organização e os usuários com as permissões "Gerenciar variáveis de ações da organização" ou "Gerenciar segredos de ações da organização" podem criar segredos ou variáveis no nível da organização.

Para obter mais informações, confira "Sobre as funções da organização personalizadas".

Para saber mais sobre como definir segredos e variáveis, confira Usar segredos em ações do GitHub e Armazenar informações em variáveis.

Além disso, qualquer pessoa que tenha acesso para executar um fluxo de trabalho pode habilitar o log de diagnóstico do executor e o log de depuração de etapas para uma nova execução do fluxo de trabalho. Para saber mais, confira Reexecutando fluxos de trabalho e trabalhos.

Habilitar log de diagnóstico do runner

O log de diagnóstico do executor fornece arquivos de log adicionais que contêm informações sobre como um executor está executando um trabalho. Dois arquivos de log extras foram adicionados ao arquivo de log:

  • O log de processo do runner, que inclui informações sobre a coordenação e a configuração de runners para executar trabalhos.
  • O log de processo do worker, que registra em log a execução de um trabalho.
  1. Para habilitar o log de diagnósticos do executor, defina o seguinte segredo ou váriável no repositório que contém o fluxo de trabalho: ACTIONS_RUNNER_DEBUG como true. Se o segredo e a variável estiverem definidos, o valor do segredo terá precedência sobre a variável.
  2. Para baixar os logs de diagnóstico do runner, baixe o arquivo de log da execução de fluxo de trabalho. Os logs de diagnóstico do executor estão contidos na pasta runner-diagnostic-logs. Para saber mais sobre como baixar logs, confira Usando logs de execução de fluxo de trabalho.

Habilitar log de depuração da etapa

O log de depuração da etapa aumenta o detalhamento dos logs de um trabalho durante e depois da execução dele.

  1. Para habilitar o log de depuração em etapas, defina o seguinte segredo ou variável no repositório que contém o fluxo de trabalho: ACTIONS_STEP_DEBUG como true. Se o segredo e a variável estiverem definidos, o valor do segredo terá precedência sobre a variável.
  2. Depois que o segredo ou a variável são definidos, mais eventos de depuração são mostrados nos logs de etapas. Para saber mais, confira Usando logs de execução de fluxo de trabalho.