使用工作流程运行日志

您可以查看、搜索和下载工作流程运行中每个作业的日志。

GitHub Actions 可用于 GitHub Free、GitHub Pro、组织的 GitHub Free、GitHub Team、GitHub Enterprise Cloud 和 GitHub AE。 GitHub Actions 不适用于使用旧版按仓库计划的帐户所拥有的私有仓库。

注意: GitHub Actions 目前正在测试用于 GitHub AE 。

您可以从工作流程运行页面查看工作流程运行是在进行中,还是已完成。 您必须登录到 GitHub 帐户才能查看工作流程运行信息,包括公共仓库。 更多信息请参阅“GitHub 上的访问权限”。

如果运行已完成,则可查看运行结果是成功、失败、已取消还是中性。 如果运行失败,您可以查看并搜索构建日志,来诊断失败原因并重新运行工作流程。 您也可以查看可计费作业执行分钟数,或下载日志和创建构件。

GitHub Actions 使用 Checks API 来输出工作流程的状态、结果和日志。 GitHub 对每个工作流程创建新检查套件。 检查套件包含检查工作流程中每项作业的运行,而每项作业包含步骤。 GitHub Actions 作为工作流程中的一个步骤运行。 有关检查 API 的详细信息,请参阅“检查”。

注:确保只将有效的工作流程文件提交到仓库。 如果.github/workflows含有无效的工作流程文件,则 GitHub Actions 将为每次新提交生成失败的工作流程运行。

查看日志以诊断故障

如果工作流程运行失败,您可以查看是哪个步骤导致了失败,然后审查失败步骤的创建日志进行故障排除。 您可以查看每个步骤运行的时长。 也可以将永久链接复制到日志文件中的特定行,与您的团队分享。 执行这些步骤需要对仓库的读取访问权限。

除了工作流程文件中配置的步骤外,GitHub 为每个作业添加了另外两个步骤,以设置和完成作业的执行。 这些步骤以名称"设置作业"和"完成作业"记录在工作流程运行中。

对于在 GitHub 托管的运行器上运行的作业,“设置作业”记录运行器虚拟环境的详细信息。 并包含一个链接,可链接到运行器机器上的预安装工具列表。

  1. 在 GitHub AE 上,导航到仓库的主页面。

  2. 在仓库名称下,单击 Actions(操作)主仓库导航中的操作选项卡

  3. 在左侧边栏中,单击您想要查看的工作流程。 左侧边栏中的工作流程列表

  4. 从工作流程运行列表中,单击要查看的运行的名称。 工作流程运行的名称

  5. 在左侧边栏中,单击您要查看的作业。 选择工作流程作业

  6. 展开运行 Super-Linter 步骤以查看结果。 Super linter 工作流程结果

  7. (可选)要获取指向日志中特定行的链接,请单击该步骤的行号。 然后,您可以从 web 浏览器的地址栏中复制链接。 复制链接的按钮

搜索日志

您可以搜索特定步骤的创建日志。 在搜索日志时,只有展开的步骤会包含在结果中。 执行这些步骤需要对仓库的读取访问权限。

  1. 在 GitHub AE 上,导航到仓库的主页面。

  2. 在仓库名称下,单击 Actions(操作)主仓库导航中的操作选项卡

  3. 在左侧边栏中,单击您想要查看的工作流程。 左侧边栏中的工作流程列表

  4. 从工作流程运行列表中,单击要查看的运行的名称。 工作流程运行的名称

  5. 在左侧边栏中,单击您要查看的作业。 选择工作流程作业

  6. 在日志输出的右上角,在 Search logs(搜索日志)搜索框中输入搜索查询。

    搜索日志的搜索框

下载日志

您可以从工作流程运行中下载日志文件。 您也可以下载工作流程的构件。 更多信息请参阅“使用构件持久化工作流程”。 执行这些步骤需要对仓库的读取访问权限。

  1. 在 GitHub AE 上,导航到仓库的主页面。

  2. 在仓库名称下,单击 Actions(操作)主仓库导航中的操作选项卡

  3. 在左侧边栏中,单击您想要查看的工作流程。 左侧边栏中的工作流程列表

  4. 从工作流程运行列表中,单击要查看的运行的名称。 工作流程运行的名称

  5. 在左侧边栏中,单击您要查看的作业。 选择工作流程作业

  6. 在右上角单击 并选择 Download log archive(下载日志存档)

    下载日志下拉菜单

删除日志

您可以从工作流程运行中删除日志文件。 执行这些步骤需要对仓库的写入访问权限。

  1. 在 GitHub AE 上,导航到仓库的主页面。

  2. 在仓库名称下,单击 Actions(操作)主仓库导航中的操作选项卡

  3. 在左侧边栏中,单击您想要查看的工作流程。 左侧边栏中的工作流程列表

  4. 从工作流程运行列表中,单击要查看的运行的名称。 工作流程运行的名称

  5. 在右上角单击 .

    烤肉串水平图标

  6. 要删除日志文件,单击 Delete all logs(删除所有日志)按钮并审查确认提示。

    删除所有日志

删除日志后,Delete all logs(删除所有日志) 按钮将会移除,以表示在工作流程运行中没有日志文件。

使用 GitHub CLI 查看日志

要查看特定作业的日志,请使用 run view 子命令。 将 run-id 替换为您想要查看其日志的运行的 ID。 GitHub CLI 将返回一个交互式菜单,供您从运行中选择作业。 如果您没有指定 run-id,GitHub CLI 将返回一个交互式菜单,让您选择最近的运行,然后返回另一个交互式菜单,让您从运行中选择作业。

gh run view run-id --log

您也可以使用 --bob 标记来指定作业 ID。 将 job-id 替换为您想要查看其日志的作业的 ID。

gh run view --job job-id --log

您可以使用 grep 来搜索日志。 例如,此命令将返回所有包含单词 error 的日志条目。

gh run view --job job-id --log | grep error

要过滤日志中任何失败的步骤,请使用 --log-fail 而不是 --log

gh run view --job job-id --log-failed

此文档对您有帮助吗?隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。