title | intro | versions | shortTitle | redirect_from | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Disabling and enabling a workflow |
You can disable and re-enable a workflow using the {% data variables.product.prodname_dotcom %} UI, the REST API, or {% data variables.product.prodname_cli %}. |
|
Disable & enable a workflow |
|
{% data reusables.actions.enterprise-github-hosted-runners %}
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 {% data variables.product.prodname_dotcom %}.
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 %}
Warning: {% data reusables.actions.scheduled-workflows-disabled %}
{% endwarning %}
You can also disable and enable a workflow using the REST API. For more information, see "AUTOTITLE."
{% webui %}
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %}
-
In the left sidebar, click the workflow you want to disable.
-
Click {% octicon "kebab-horizontal" aria-label="Show workflow options" %} to display a dropdown menu and click Disable workflow.
{% ifversion workflow-nav-2022 -%}
{%- else -%}
The disabled workflow is marked {% octicon "stop" aria-label="The stop icon" %} to indicate its status.
{% endwebui %}
{% cli %}
{% data reusables.cli.cli-learn-more %}
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, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a workflow.
gh workflow disable WORKFLOW
{% endcli %}
{% webui %}
You can re-enable a workflow that was previously disabled.
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %}
-
In the left sidebar, click the workflow you want to enable.
{% ifversion workflow-nav-2022 -%}
{%- else -%}
{%- endif %}
-
Click Enable workflow.
{% endwebui %}
{% cli %}
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, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a workflow.
gh workflow enable WORKFLOW
{% endcli %}