Skip to main content

禁用和启用工作流

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

Tool navigation

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

在许多情况下,暂时禁用工作流程可能很有用。 以下是禁用工作流程可能有帮助的几个例子:

  • 产生请求过多或错误的工作流程错误,对外部服务产生负面影响。
  • 不重要但会耗费您帐户上太多分钟数的工作流程。
  • 向已关闭的服务发送请求的工作流程。
  • 复刻仓库上不需要的工作流程(例如预定的工作流程)。

警告:为防止不必要的工作流程运行,可能会自动禁用计划的工作流程。 在复刻公共仓库时,默认情况下将禁用计划的工作流程。 在公共仓库中,当 60 天内未发生仓库活动时,将自动禁用计划的工作流程。

您也可以使用 REST API 禁用和启用工作流程。 有关详细信息,请参阅“工作流的 REST API 终结点”。

禁用工作流程

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

  2. 在存储库名称下,单击 “操作”。

    “github/docs”存储库的选项卡的屏幕截图。 “操作”选项卡以橙色边框突出显示。

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

  4. 单击 以显示下拉菜单,然后单击“禁用工作流”。

    工作流的屏幕截图。 标有水平烤肉串图标的“显示工作流选项”按钮和“禁用工作流”菜单项以深橙色边框标出。

若要详细了解 GitHub CLI,请参阅“关于 GitHub CLI”。

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

gh workflow disable WORKFLOW

启用工作流程

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

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

  2. 在存储库名称下,单击 “操作”。

    “github/docs”存储库的选项卡的屏幕截图。 “操作”选项卡以橙色边框突出显示。

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

    “Actions”页的屏幕截图。 在左侧边栏中,工作流名称用深橙色边框突出显示。

  4. 单击“启用工作流”。

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

gh workflow enable WORKFLOW