跳至主要内容

启用调试日志记录

如果工作流日志未提供足够的详细信息来诊断工作流、作业或步骤为何无法按预期工作,则可以启用其他调试日志记录。

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

  • 要在 GitHub 上为个人帐户仓库创建密钥或变量,您必须是仓库所有者。要在 GitHub 上为组织仓库创建密钥或变量,您必须具有 `admin` 访问权限。最后,要通过 REST API 为个人帐户仓库或组织仓库创建密钥或变量,您必须具有协作者访问权限。
  • 要在个人帐户仓库中为环境创建密钥或变量,您必须是仓库所有者。要在组织仓库中为环境创建密钥或变量,您必须具有 `admin` 访问权限。有关环境的更多信息,请参阅“管理部署环境”。
  • 组织所有者可以在组织级别创建密钥或变量。

有关设置密钥和变量的更多信息,请参阅“在 GitHub Actions 中使用密钥”和“在变量中存储信息”。

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

启用运行器诊断日志记录

运行器诊断日志记录提供包含有关运行器如何执行作业的信息的其他日志文件。两个额外的日志文件被添加到日志存档中。

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

启用步骤调试日志记录

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

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