我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

管理工作流程运行

您可以查看工作流程中每个步骤的状态和结果,取消待定的工作流程,查看可计费作业执行分钟数,调试并重新运行失败的工作流程,搜索并下载日志,以及下载构件。

GitHub 操作 可用于 GitHub Free、GitHub Pro、组织的 GitHub Free、GitHub Team、GitHub Enterprise Cloud 和 GitHub One。 GitHub 操作 不适用于使用旧版按仓库计划的帐户所拥有的私有仓库。 更多信息请参阅“GitHub 的产品”。

本文内容

关于工作流程管理

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

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

标注的工作流程运行映像

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

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

查看工作流程历史记录

您可以查看工作流程运行中的每项作业以及作业中的每个步骤。 更多信息请参阅“GitHub 操作 的核心概念”。对仓库具有读取权限的用户可以执行这些步骤。

除了工作流程文件中配置的步骤外,每个作业还包括用于启动和完成作业执行的其他任务。 这些步骤工作流程运行中记录为"设置作业"和"完成作业"。

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

  1. 在 GitHub 上,导航到仓库的主页面。
  2. 在仓库名称下,单击 Actions(操作)
    主仓库导航中的操作选项卡
  3. 在左侧边栏中,单击您想要查看的工作流程。
    左侧边栏中的工作流程列表
  4. 在“Workflow runs(工作流程运行)”下,单击您想要查看的运行的名称。
    工作流程运行的名称
  5. (可选)如果运行失败,要重新运行工作流程,请使用工作流程右上角的 Re-run checks(重新运行检查)下拉菜单,然后选择 Re-run all checks(重新运行所有检查)
    重新运行检查下拉菜单

取消工作流程运行

当您取消工作流程运行时,GitHub 会取消属于该工作流程的所有步骤。 对仓库具有写入级权限的用户可以执行这些步骤。

  1. 在 GitHub 上,导航到仓库的主页面。
  2. 在仓库名称下,单击 Actions(操作)
    主仓库导航中的操作选项卡
  3. 在左侧边栏中,单击您想要查看的工作流程。
    左侧边栏中的工作流程列表
  4. 在“Workflow runs(工作流程运行)”下,单击您想要查看的运行的名称。
    工作流程运行的名称
  5. 在工作流程右上角单击 Cancel check suite(取消检查套件)
    取消检查套件按钮

删除工作流程运行

您可以删除已完成或超过 2 周的工作流程运行。 对仓库具有写入级权限的用户可以执行这些步骤。

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

  2. 在仓库名称下,单击 Actions(操作)

    主仓库导航中的操作选项卡

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

    左侧边栏中的工作流程列表

  4. 要删除工作流程运行,请使用 下拉菜单并选择 Delete workflow run(删除工作流程运行)

    删除工作流程运行

  5. 查看确认提示并单击 Yes, permanently delete this workflow run(是,永久删除此工作流程运行)

    删除工作流程运行确认

查看可计费作业执行分钟数

您可以查看作业的执行时间,包括某个作业累积的可计费分钟数。

仅为在私有仓库上运行,使用 GitHub- 托管的运行器的作业显示可计费作业执行分钟数。 如果在公共仓库中使用 GitHub 操作,或在自托管的运行器中运行作业时,将没有可计费分钟数。

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

  2. 在仓库名称下,单击 Actions(操作)

    主仓库导航中的操作选项卡

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

    左侧边栏中的工作流程列表

  4. 在“Workflow runs(工作流程运行)”下,单击您想要查看的运行的名称。

    工作流程运行的名称

  5. 在作业摘要下,单击 Run and billable time details(运行和可计费时间详细信息)

    运行和可计费时间详细信息链接

    注意:显示的可计费时间不包括任何四舍五入或分钟乘数。 要查看您的 GitHub 操作 总使用情况,包括四舍五入和分钟乘法,请参阅"查看您的 GitHub 操作 使用情况。"

查看日志以诊断故障

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

GitHub 会将整个创建日志和构件存储 90 天。

  1. 在 GitHub 上,导航到仓库的主页面。
  2. 在仓库名称下,单击 Actions(操作)
    主仓库导航中的操作选项卡
  3. 在左侧边栏中,单击您想要查看的工作流程。
    左侧边栏中的工作流程列表
  4. 在“Workflow runs(工作流程运行)”下,单击您想要查看的运行的名称。
    工作流程运行的名称
  5. 在左侧边栏中,单击您要查看的作业。
    左侧边栏中的作业列表
  6. 要展开失败步骤的日志,请单击该步骤。
    失败的步骤名称
  7. (可选)要获取指向日志中特定行的链接,请单击该步骤的行号。 您可以从 web 浏览器的地址栏中复制链接。
    复制链接的按钮

搜索日志

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

  1. 在 GitHub 上,导航到仓库的主页面。
  2. 在仓库名称下,单击 Actions(操作)
    主仓库导航中的操作选项卡
  3. 在左侧边栏中,单击您想要查看的工作流程。
    左侧边栏中的工作流程列表
  4. 在“Workflow runs(工作流程运行)”下,单击您想要查看的运行的名称。
    工作流程运行的名称
  5. 在左侧边栏中,单击您要查看的作业。
    左侧边栏中的作业列表
  6. 要展开想包含在搜索中的每个步骤,请单击该步骤。
    步骤名称
  7. 在日志输出的右上角,在 Search logs(搜索日志)搜索框中输入搜索查询。
    搜索日志的搜索框

下载日志

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

  1. 在 GitHub 上,导航到仓库的主页面。
  2. 在仓库名称下,单击 Actions(操作)
    主仓库导航中的操作选项卡
  3. 在左侧边栏中,单击您想要查看的工作流程。
    左侧边栏中的工作流程列表
  4. 在“Workflow runs(工作流程运行)”下,单击您想要查看的运行的名称。
    工作流程运行的名称
  5. 要下载日志,请使用 Download logs(下载日志)下拉菜单,然后选择要下载的日志。
    下载日志下拉菜单

删除日志

您可以从工作流程运行中删除日志文件。 对仓库具有写入级权限的用户可以执行这些步骤。

  1. 在 GitHub 上,导航到仓库的主页面。
  2. 在仓库名称下,单击 Actions(操作)
    主仓库导航中的操作选项卡
  3. 在左侧边栏中,单击您想要查看的工作流程。
    左侧边栏中的工作流程列表
  4. 在“Workflow runs(工作流程运行)”下,单击您想要查看的运行的名称。
    工作流程运行的名称
  5. 要删除日志文件,单击 Delete all logs(删除所有日志)按钮并审查确认提示。
    删除所有日志
    删除日志后,Delete all logs(删除所有日志)按钮将被删除,以表明工作流程运行中未剩下任何日志文件。

启用调试日志

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

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

  • 要在组织级别创建密码,必须具有管理员访问权限。
  • 要为用户帐户仓库创建密码,您必须是仓库所有者。 要为组织仓库创建密码,您必须具有管理员访问权限。
  • 要使用 REST API 创建密码,必须对仓库具有写入权限。 For more information, see "GitHub 操作 secrets API."

有关设置密码的更多信息,请参阅“创建和使用加密密码”。

启用运行程序诊断日志

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. 设置密码后,步骤日志中会显示更多调试事件。 更多信息请参阅“查看日志以诊断故障”

延伸阅读

问问别人

找不到要找的内容?

联系我们