Skip to main content

启用调试日志记录

如果工作流程日志没有提供足够的详细信息来诊断工作流程、作业或步骤未按预期工作的原因,您可以启用额外的调试日志。

这些额外的日志将通过在包含工作流的仓库中设置机密或变量来启用,因此将应用相同的权限要求:

  • 若要在 GitHub 上为个人帐户存储库创建机密或变量,你必须是存储库所有者。 若要在 GitHub 上为组织存储库创建机密或变量,你必须拥有 admin 访问权限。 最后,若要通过 REST API 为个人帐户存储库或组织存储库创建机密或变量,你必须拥有协作者访问权限。
  • 若要在个人帐户存储库中为某个环境创建机密或变量,你必须是存储库所有者。 若要在组织存储库中为某个环境创建机密或变量,你必须拥有 admin 访问权限。 有关环境的详细信息,请参阅“使用环境进行部署”。
  • 要在组织级别创建机密或变量,你必须是组织所有者。

若要详细了解如何设置机密和变量,请参阅“在 GitHub Actions 中使用机密”和“变量”。

此外,有权运行工作流的任何人都可以为工作流重新运行启用运行器诊断日志记录和步骤调试日志记录。 有关详细信息,请参阅“重新运行工作流程和作业”。

启用运行程序诊断日志

Runner diagnostic logging provides additional log files that contain information about how a runner is executing a job. 两个额外的日志文件被添加到日志存档中:

  • 运行程序进程日志,其中包含关于如何协调和设置运行程序执行作业的信息。
  • 工作程序进程日志,用于记录作业执行情况。
  1. 若要启用运行器诊断日志记录,请在包含工作流 ACTIONS_RUNNER_DEBUG 的存储库中将以下机密或变量设置为 true。如果同时设置了机密和变量,则机密的值优先于变量。
  2. 要下载运行程序诊断日志,请下载工作流程运行情况的日志存档。 运行程序诊断日志包含在 runner-diagnostic-logs 文件夹中。 关于下载日志的详细信息,请参阅“使用工作流运行日志”。

启用步骤调试日志

步骤调试日志增加了作业执行期间和执行之后的作业日志的详细程度。

  1. 若要启用步骤调试日志记录,请在包含工作流 ACTIONS_STEP_DEBUG 的存储库中将以下机密或变量设置为 true。如果同时设置了机密和变量,则机密的值优先于变量。
  2. 设置机密或变量后,步骤日志中会显示更多调试事件。 有关详细信息,请参阅“使用工作流运行日志”。