Skip to main content

Disabling and enabling a workflow

You can disable and re-enable a workflow using the GitHub UI, the REST API, or GitHub CLI.

注意:GitHub Enterprise Server 目前不支持 GitHub 托管的运行器。 可以在 GitHub public roadmap 上查看有关未来支持计划的更多信息。

Disabling a workflow allows you to stop a workflow from being triggered without having to delete the file from the repo. You can easily re-enable the workflow again on GitHub.

Temporarily disabling a workflow can be useful in many scenarios. These are a few examples where disabling a workflow might be helpful:

  • A workflow error that produces too many or wrong requests, impacting external services negatively.
  • A workflow that is not critical and is consuming too many minutes on your account.
  • A workflow that sends requests to a service that is down.
  • Workflows on a forked repository that aren't needed (for example, scheduled workflows).

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

You can also disable and enable a workflow using the REST API. For more information, see the "Actions REST API."

Disabling a workflow

  1. On your GitHub Enterprise Server instance, navigate to the main page of the repository.

  2. 在你的存储库名称下,单击 “操作”。 主存储库导航中的“操作”选项卡

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

    Actions select workflow

  4. Click .

    Actions kebab menu

  5. Click Disable workflow.

    actions disable workflow

    The disabled workflow is marked to indicate its status.

    actions list disabled workflow

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

To disable a workflow, use the workflow disable subcommand. Replace workflow with either the name, ID, or file name of the workflow you want to disable. For example, "Link Checker", 1234567, or "link-check-test.yml". If you don't specify a workflow, GitHub CLI returns an interactive menu for you to choose a workflow.

gh workflow disable WORKFLOW

Enabling a workflow

You can re-enable a workflow that was previously disabled.

  1. On your GitHub Enterprise Server instance, navigate to the main page of the repository.

  2. 在你的存储库名称下,单击 “操作”。 主存储库导航中的“操作”选项卡

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

    Actions select disabled workflow

  4. Click Enable workflow.

    Actions enable workflow

To enable a workflow, use the workflow enable subcommand. Replace workflow with either the name, ID, or file name of the workflow you want to enable. For example, "Link Checker", 1234567, or "link-check-test.yml". If you don't specify a workflow, GitHub CLI returns an interactive menu for you to choose a workflow.

gh workflow enable WORKFLOW