forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add UI procedures for disabling and enabling workflows (github#15316)
Co-authored-by: Rachael Sewell <[email protected]>
- Loading branch information
Showing
9 changed files
with
62 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions
52
content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
title: Disabling and enabling a workflow | ||
intro: You can temporarily disable and re-enable an individual workflow on {% data variables.product.prodname_dotcom %}. | ||
product: '{% data reusables.gated-features.actions %}' | ||
versions: | ||
free-pro-team: '*' | ||
enterprise-server: '>=2.23' | ||
--- | ||
|
||
{% data reusables.actions.enterprise-beta %} | ||
{% 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 %} | ||
|
||
### Disabling a workflow | ||
|
||
You can manually disable a workflow so that it won't execute any workflow runs. A disabled workflow is not deleted, and can be re-enabled. | ||
|
||
{% data reusables.repositories.navigate-to-repo %} | ||
{% data reusables.repositories.actions-tab %} | ||
1. In the left sidebar, click the workflow you want to disable. | ||
 | ||
1. Click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. | ||
 | ||
1. Click **Disable workflow**. | ||
 | ||
The disabled workflow is marked {% octicon "stop" aria-label="The stop icon" %} to indicate its status. | ||
 | ||
|
||
### Enabling a workflow | ||
|
||
You can re-enable a workflow that was previously disabled. | ||
|
||
{% data reusables.repositories.navigate-to-repo %} | ||
{% data reusables.repositories.actions-tab %} | ||
1. In the left sidebar, click the workflow you want to enable. | ||
 | ||
1. Click **Enable workflow**. | ||
 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
To prevent unnecessary workflow runs, scheduled workflows may be disabled automatically. When a public repository is forked, scheduled workflows are disabled by default. In a public repository, scheduled workflows are automatically disabled when no repository activity has occurred in 60 days. |