禁用和启用工作流

您可以使用 GitHub UI、REST API 或 GitHub CLI 禁用和重新启用工作流。

本文内容

禁用工作流允许您停止工作流触发，而无需从仓库中删除文件。您可以轻松地在 GitHub 上重新启用工作流。

在许多情况下，临时禁用工作流可能很有用。以下是一些禁用工作流可能有所帮助的示例

  • 工作流错误导致太多或错误的请求，对外部服务造成负面影响。
  • 一个不重要的工作流，在您的帐户上消耗了太多分钟。
  • 向已关闭的服务发送请求的工作流程。
  • 在分叉仓库中不需要的工作流程（例如，计划工作流程）。

警告：为了防止不必要的工作流程运行，计划工作流程可能会被自动禁用。当公共仓库被分叉时，计划工作流程默认情况下会被禁用。在公共仓库中，当仓库 60 天内没有活动时，计划工作流程会自动禁用。

您也可以使用 REST API 禁用和启用工作流程。有关更多信息，请参阅“工作流程的 REST API 端点”。

禁用工作流程

  1. 在 GitHub.com 上，导航到仓库的主页。

  2. 在您的仓库名称下，单击 操作.

    Screenshot of the tabs for the "github/docs" repository. The "Actions" tab is highlighted with an orange outline.

  3. 在左侧边栏中，单击您要禁用的工作流程。

  4. 单击 以显示下拉菜单，然后单击禁用工作流程。

    Screenshot of a workflow. The "Show workflow options" button, labeled with a horizontal kebab icon, and the "Disable workflow" menu item are outlined in dark orange.

要了解有关 GitHub CLI 的更多信息，请参阅“关于 GitHub CLI”。

要禁用工作流程，请使用workflow disable子命令。将workflow替换为您要禁用的工作流程的名称、ID 或文件名。例如，"Link Checker"、1234567 或 "link-check-test.yml"。如果您没有指定工作流程，GitHub CLI 会返回一个交互式菜单供您选择工作流程。

gh workflow disable WORKFLOW

启用工作流程

您可以重新启用之前禁用的工作流程。

  1. 在 GitHub.com 上，导航到仓库的主页。

  2. 在您的仓库名称下，单击 操作.

    Screenshot of the tabs for the "github/docs" repository. The "Actions" tab is highlighted with an orange outline.

  3. 在左侧边栏中，单击您要启用的工作流程。

    Screenshot of the "Actions" page. In the left sidebar, a workflow name is highlighted with an outline in dark orange.

  4. 单击启用工作流程。

要启用工作流程，请使用workflow enable子命令。将workflow替换为您要启用的工作流程的名称、ID 或文件名。例如，"Link Checker"、1234567 或 "link-check-test.yml"。如果您没有指定工作流程，GitHub CLI 会返回一个交互式菜单供您选择工作流程。

gh workflow enable WORKFLOW