跳至主要内容

禁用和启用工作流

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

禁用工作流允许您停止触发工作流,而无需从存储库中删除文件。您可以在 GitHub 上轻松地再次启用工作流。

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

  • 导致过多或错误请求的工作流错误,对外部服务造成负面影响。
  • 不重要的工作流,并在您的帐户上消耗了过多的分钟数。
  • 向已停用的服务发送请求的工作流。
  • 派生存储库上不需要的工作流(例如,计划工作流)。

警告

为了防止不必要的工作流运行,计划工作流可能会自动禁用。当公共存储库被派生时,计划工作流默认情况下会被禁用。在公共存储库中,如果 60 天内没有存储库活动,则计划工作流会自动禁用。

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

禁用工作流

  1. 在 GitHub 上,导航到存储库的主页。

  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 或文件名。例如,“链接检查器”、“1234567”或“link-check-test.yml”。如果您未指定工作流,GitHub CLI 会返回一个交互式菜单供您选择工作流。

gh workflow disable WORKFLOW

启用工作流

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

  1. 在 GitHub 上,导航到存储库的主页。

  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