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

管理工作流程运行

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

GitHub 操作 is available with GitHub Free, GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. GitHub 操作 is unavailable for per-repository plans, which are legacy billing plans. For more information, see "GitHub's products."

本文内容

关于工作流程权限

任何拥有已启用 GitHub 操作仓库的访问权限的人员都可以看到有关工作流程的所有信息。 读取权限允许您下载构件和查看工作流程文件、运行历史记录和日志。

您必须至少拥有写入级别权限才能取消或重新运行工作流程。

更多信息请参阅“GitHub 上的访问权限”。

关于工作流程管理

您可以从工作流程运行页面查看工作流程运行是在进行中,还是已完成。 如果运行正在进行中,您可以取消运行。 如果运行已完成,则可查看运行结果是成功、失败、已取消还是中性。 如果运行失败,您可以查看并搜索构建日志,来诊断失败原因并重新运行工作流程。 您也可以下载日志和构建构件。

标注的工作流程运行映像

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

查看工作流程历史记录

您可以查看工作流程运行中的每项作业以及作业中的每个步骤。 更多信息请参阅“关于 GitHub 操作”。

每项作业默认包含“设置作业”步骤和“完成作业”步骤,以及在工作流程文件中配置的操作。

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Actions.

    Actions tab in the main repository navigation

  3. In the left sidebar, click the workflow you want to see.

    Workflow list in left sidebar

  4. Under "Workflow runs", click the name of the run you want to see.

    Name of workflow run

  5. (可选)如果运行失败,要重新运行工作流程,请使用工作流程右上角的 Re-run checks(重新运行检查)下拉菜单,然后选择 Re-run all checks(重新运行所有检查)

    重新运行检查下拉菜单

取消工作流程运行

当您取消工作流程运行时,GitHub 会取消属于该工作流程的所有步骤。

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Actions.

    Actions tab in the main repository navigation

  3. In the left sidebar, click the workflow you want to see.

    Workflow list in left sidebar

  4. Under "Workflow runs", click the name of the run you want to see.

    Name of workflow run

  5. 在工作流程右上角单击 Cancel check suite(取消检查套件)

    取消检查套件按钮

查看日志以诊断故障

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

对于推送,GitHub 会将整个创建日志和构件存储 90 天,对于拉取请求则存储 30 天。 每当有人推送到拉取请求时,拉取请求的保存期就会重新开始计算。

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Actions.

    Actions tab in the main repository navigation

  3. In the left sidebar, click the workflow you want to see.

    Workflow list in left sidebar

  4. Under "Workflow runs", click the name of the run you want to see.

    Name of workflow run

  5. In the left sidebar, click the job you want to see.

    List of jobs in left sidebar

  6. 要展开失败步骤的日志,请单击该步骤。

    失败的步骤名称

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

    复制链接的按钮

搜索日志

您可以搜索特定步骤的创建日志。 在搜索日志时,只有展开的步骤会包含在结果中。

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Actions.

    Actions tab in the main repository navigation

  3. In the left sidebar, click the workflow you want to see.

    Workflow list in left sidebar

  4. Under "Workflow runs", click the name of the run you want to see.

    Name of workflow run

  5. In the left sidebar, click the job you want to see.

    List of jobs in left sidebar

  6. 要展开想包含在搜索中的每个步骤,请单击该步骤。

    步骤名称

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

    搜索日志的搜索框

下载日志和构件

构件是创建并测试代码时所创建的文件。 例如,构件可能包含二进制或包文件、测试结果、屏幕截图或日志文件。 当运行完成时,这些文件将从运行工作流程的虚拟环境中删除,并且存档以供下载。

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Actions.

    Actions tab in the main repository navigation

  3. In the left sidebar, click the workflow you want to see.

    Workflow list in left sidebar

  4. Under "Workflow runs", click the name of the run you want to see.

    Name of workflow run

  5. 要下载日志,请使用 Download logs(下载日志)下拉菜单,然后选择要下载的日志。

    下载日志下拉菜单

  6. 要下载构件,请使用 Artifacts(构件)下拉菜单,然后选择要下载的构件。

    构件下拉菜单

启用调试日志

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

这些额外的日志通过在包含工作流程的仓库中设置密码来控制。 关于设置密码的更多信息,请参阅“创建和使用密码(加密变量)”。

启用运行程序诊断日志

运行程序诊断日志提供额外的日志文件,其中包含关于运行程序如何执行操作的信息。 两个额外的日志文件被添加到日志存档中:

  • 运行程序进程日志,其中包含关于如何协调和设置运行程序执行作业的信息。
  • 工作程序进程日志,用于记录作业执行情况。
  1. 要启用运行程序诊断日志,请在包含工作流程的仓库中设置以下密码:将 ACTIONS_RUNNER_DEBUG 设置为 true

  2. 要下载运行程序诊断日志,请下载工作流程运行情况的日志存档。 运行程序诊断日志包含在 runner-diagnostic-logs 文件夹中。 关于下载日志的更多信息,请参阅“下载日志和构件”。

启用步骤调试日志

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

  1. 要启用步骤调试日志,必须在包含工作流程的仓库中设置以下密码:将 ACTIONS_STEP_DEBUG 设置为 true

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

延伸阅读

问问别人

找不到要找的内容?

联系我们