Skip to content

Commit 1e4c44f

Browse files
authored
Merge pull request #88 from github/repo-sync
repo sync
2 parents f41b02a + 4b249e8 commit 1e4c44f

23 files changed

+194
-8
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
98.7 KB
Loading
Loading
Loading
Binary file not shown.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: Disabling and enabling a workflow
3+
intro: You can temporarily disable and re-enable an individual workflow on {% data variables.product.prodname_dotcom %}.
4+
product: '{% data reusables.gated-features.actions %}'
5+
versions:
6+
free-pro-team: '*'
7+
enterprise-server: '>=2.23'
8+
---
9+
10+
{% data reusables.actions.enterprise-beta %}
11+
{% data reusables.actions.enterprise-github-hosted-runners %}
12+
13+
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 %}.
14+
15+
Temporarily disabling a workflow can be useful in many scenarios. These are a few examples where disabling a workflow might be helpful:
16+
17+
- A workflow error that produces too many or wrong requests, impacting external services negatively.
18+
- A workflow that is not critical and is consuming too many minutes on your account.
19+
- A workflow that sends requests to a service that is down.
20+
- Workflows on a forked repository that aren't needed (for example, scheduled workflows).
21+
22+
{% warning %}
23+
24+
**Warning:** {% data reusables.actions.scheduled-workflows-disabled %}
25+
26+
{% endwarning %}
27+
28+
### Disabling a workflow
29+
30+
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.
31+
32+
{% data reusables.repositories.navigate-to-repo %}
33+
{% data reusables.repositories.actions-tab %}
34+
1. In the left sidebar, click the workflow you want to disable.
35+
![actions select workflow](/assets/images/actions-select-workflow.png)
36+
1. Click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
37+
![actions kebab menu](/assets/images/help/repository/actions-workflow-menu-kebab.png)
38+
1. Click **Disable workflow**.
39+
![actions disable workflow](/assets/images/help/repository/actions-disable-workflow.png)
40+
The disabled workflow is marked {% octicon "stop" aria-label="The stop icon" %} to indicate its status.
41+
![actions list disabled workflow](/assets/images/help/repository/actions-find-disabled-workflow.png)
42+
43+
### Enabling a workflow
44+
45+
You can re-enable a workflow that was previously disabled.
46+
47+
{% data reusables.repositories.navigate-to-repo %}
48+
{% data reusables.repositories.actions-tab %}
49+
1. In the left sidebar, click the workflow you want to enable.
50+
![actions select disabled workflow](/assets/images/help/repository/actions-select-disabled-workflow.png)
51+
1. Click **Enable workflow**.
52+
![actions enable workflow](/assets/images/help/repository/actions-enable-workflow.png)

content/actions/managing-workflow-runs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ versions:
2323
{% link_in_list /manually-running-a-workflow %}
2424
{% link_in_list /re-running-a-workflow %}
2525
{% link_in_list /canceling-a-workflow %}
26+
{% link_in_list /disabling-and-enabling-a-workflow %}
2627
{% link_in_list /deleting-a-workflow-run %}
2728
{% link_in_list /viewing-job-execution-time %}
2829
{% link_in_list /downloading-workflow-artifacts %}

content/actions/reference/usage-limits-billing-and-administration.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,23 @@ redirect_from:
66
- /actions/getting-started-with-github-actions/usage-and-billing-information-for-github-actions
77
versions:
88
free-pro-team: '*'
9+
enterprise-server: '>=2.22'
910
---
1011

1112
{% data reusables.actions.enterprise-beta %}
1213
{% data reusables.actions.enterprise-github-hosted-runners %}
1314

1415
### About billing for {% data variables.product.prodname_actions %}
1516

17+
{% if currentVersion == "free-pro-team@latest" %}
1618
{% data reusables.github-actions.actions-billing %} For more information, see "[About billing for {% data variables.product.prodname_actions %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions)."
19+
{% else %}
20+
GitHub Actions usage is free for {% data variables.product.prodname_ghe_server %} that use self-hosted runners.
21+
{% endif %}
1722

1823
### Usage limits
1924

25+
{% if currentVersion == "free-pro-team@latest" %}
2026
There are some limits on {% data variables.product.prodname_actions %} usage when using {% data variables.product.prodname_dotcom %}-hosted runners. These limits are subject to change.
2127

2228
{% note %}
@@ -37,13 +43,29 @@ There are some limits on {% data variables.product.prodname_actions %} usage whe
3743
| Team | 60 | 5 |
3844
| Enterprise | 180 | 50 |
3945
- **Job matrix** - {% data reusables.github-actions.usage-matrix-limits %}
46+
{% else %}
47+
Usage limits apply to self-hosted runners. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)."
48+
{% endif %}
4049

50+
{% if currentVersion == "free-pro-team@latest" %}
4151
### Usage policy
4252

4353
In addition to the usage limits, you must ensure that you use {% data variables.product.prodname_actions %} within the [GitHub Terms of Service](/articles/github-terms-of-service/). For more information on {% data variables.product.prodname_actions %}-specific terms, see the [GitHub Additional Product Terms](/github/site-policy/github-additional-product-terms#a-actions-usage).
54+
{% endif %}
4455

4556
### Disabling or limiting {% data variables.product.prodname_actions %} for your repository or organization
4657

4758
{% data reusables.github-actions.disabling-github-actions %}
4859

49-
For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository)" or "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization)."
60+
For more information, see:
61+
- "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository)"
62+
- "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization)"{% if currentVersion == "free-pro-team@latest" %}
63+
- "[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account)" for {% data variables.product.prodname_ghe_cloud %}{% endif %}
64+
65+
### Disabling and enabling workflows
66+
67+
You can enable and disable individual workflows in your repository on {% data variables.product.prodname_dotcom %}.
68+
69+
{% data reusables.actions.scheduled-workflows-disabled %}
70+
71+
For more information, see "[Disabling and enabling a workflow](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow)."

content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ You can enable {% data variables.product.prodname_actions %} for your repository
1717

1818
Alternatively, you can enable {% data variables.product.prodname_actions %} in your repository but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %}
1919

20+
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.23" %}
21+
2022
### Managing {% data variables.product.prodname_actions %} permissions for your repository
2123

2224
{% note %}
@@ -31,6 +33,43 @@ Alternatively, you can enable {% data variables.product.prodname_actions %} in y
3133
4. Under "Actions permissions", select an option.
3234
![Enable, disable, or limits actions for this repository](/assets/images/help/repository/enable-repo-actions.png)
3335

36+
{% endif %}
37+
38+
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
39+
40+
### Managing {% data variables.product.prodname_actions %} permissions for your repository
41+
42+
You can disable all workflows for a repository or set a policy that configures which actions can be used in a repository.
43+
44+
{% data reusables.actions.actions-use-policy-settings %}
45+
46+
{% note %}
47+
48+
**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization)" or {% if currentVersion == "free-pro-team@latest" %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account)."{% else if currentVersion ver_gt "enterprise-server@2.21" %}"[Enforcing {% data variables.product.prodname_actions %} policies for your enterprise](/enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)."
49+
50+
{% endif %}
51+
52+
{% endnote %}
53+
54+
{% data reusables.repositories.navigate-to-repo %}
55+
{% data reusables.repositories.sidebar-settings %}
56+
{% data reusables.repositories.settings-sidebar-actions %}
57+
1. Under **Actions permissions**, select an option.
58+
![Set actions policy for this organization](/assets/images/help/repository/actions-policy.png)
59+
1. Click **Save**.
60+
61+
### Allowing specific actions to run
62+
63+
{% data reusables.actions.allow-specific-actions-intro %}
64+
65+
{% data reusables.repositories.navigate-to-repo %}
66+
{% data reusables.repositories.sidebar-settings %}
67+
{% data reusables.repositories.settings-sidebar-actions %}
68+
1. Under **Actions permissions**, select **Allow specific actions** and add your required actions to the list.
69+
![Add actions to allow list](/assets/images/help/repository/actions-policy-allow-list.png)
70+
2. Click **Save**.
71+
{% endif %}
72+
3473
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
3574
### Enabling workflows for private repository forks
3675

content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ You can enable {% data variables.product.prodname_actions %} for all repositorie
1717

1818
Alternatively, you can enable {% data variables.product.prodname_actions %} for all repositories in your organization but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %}
1919

20+
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.23" %}
21+
2022
### Managing {% data variables.product.prodname_actions %} permissions for your organization
2123

2224
{% data reusables.profile.access_profile %}
@@ -27,6 +29,44 @@ Alternatively, you can enable {% data variables.product.prodname_actions %} for
2729
![Enable, disable, or limit actions for this organization](/assets/images/help/repository/enable-org-actions.png)
2830
1. Click **Save**.
2931

32+
{% endif %}
33+
34+
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
35+
36+
### Managing {% data variables.product.prodname_actions %} permissions for your organization
37+
38+
You can disable all workflows for an organization or set a policy that configures which actions can be used in an organization.
39+
40+
{% data reusables.actions.actions-use-policy-settings %}
41+
42+
{% note %}
43+
44+
**Note:** You might not be able to manage these settings if your organization is managed by an enterprise that has overriding policy. For more information, {% if currentVersion == "free-pro-team@latest" %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account)."{% else %}"[Enforcing {% data variables.product.prodname_actions %} policies for your enterprise](/enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)."{% endif %}
45+
46+
{% endnote %}
47+
48+
{% data reusables.profile.access_profile %}
49+
{% data reusables.profile.access_org %}
50+
{% data reusables.organizations.org_settings %}
51+
{% data reusables.organizations.settings-sidebar-actions %}
52+
1. Under **Policies**, select an option.
53+
![Set actions policy for this organization](/assets/images/help/organizations/actions-policy.png)
54+
1. Click **Save**.
55+
56+
### Allowing specific actions to run
57+
58+
{% data reusables.actions.allow-specific-actions-intro %}
59+
60+
{% data reusables.profile.access_profile %}
61+
{% data reusables.profile.access_org %}
62+
{% data reusables.organizations.org_settings %}
63+
{% data reusables.organizations.settings-sidebar-actions %}
64+
1. Under **Policies**, select **Allow specific actions** and add your required actions to the list.
65+
![Add actions to allow list](/assets/images/help/organizations/actions-policy-allow-list.png)
66+
1. Click **Save**.
67+
68+
{% endif %}
69+
3070
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
3171
### Enabling workflows for private repository forks
3272

content/github/setting-up-and-managing-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,27 @@ By default, {% data variables.product.prodname_actions %} is enabled in all orga
1313

1414
For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)."
1515

16-
1716
### Managing {% data variables.product.prodname_actions %} permissions for your enterprise account
1817

18+
You can disable all workflows for an enterprise or set a policy that configures which actions can be used in an organization.
19+
20+
{% data reusables.actions.actions-use-policy-settings %}
21+
1922
{% data reusables.enterprise-accounts.access-enterprise %}
2023
{% data reusables.enterprise-accounts.policies-tab %}
2124
{% data reusables.enterprise-accounts.actions-tab %}
2225
{% data reusables.actions.enterprise-actions-permissions %}
26+
1. Click **Save**.
27+
28+
### Allowing specific actions to run
29+
30+
{% data reusables.actions.allow-specific-actions-intro %}
31+
32+
{% data reusables.enterprise-accounts.access-enterprise %}
33+
{% data reusables.enterprise-accounts.policies-tab %}
34+
{% data reusables.enterprise-accounts.actions-tab %}
35+
1. Under **Policies**, select **Allow specific actions** and add your required actions to the list.
36+
![Add actions to allow list](/assets/images/help/organizations/enterprise-actions-policy-allow-list.png)
2337

2438
### Enabling workflows for private repository forks
2539

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
If you choose the option to **Allow specific actions**, there are additional options that you can configure. For more information, see "[Allowing specific actions to run](#allowing-specific-actions-to-run)."
2+
3+
When you allow local actions only, the policy blocks all access to actions authored by {% data variables.product.prodname_dotcom %}. For example, the [`actions/checkout`](https://github.com/actions/checkout) would not be accessible.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
When you select the **Allow select actions**, there are additional options that you need to choose to configure the allowed actions:
2+
3+
- **Allow actions created by {% data variables.product.prodname_dotcom %}:** You can allow all actions created by {% data variables.product.prodname_dotcom %} to be used by workflows. Actions created by {% data variables.product.prodname_dotcom %} are located in the `actions` and `github` organization. For more information, see the [`actions`](https://github.com/actions) and [`github`](https://github.com/github) organizations.
4+
- **Allow verified actions from the Marketplace:** You can allow all verified actions in {% data variables.product.prodname_marketplace %} to be used by workflows. When GitHub has verified the creator of the action as a partner organization, the {% octicon "verified" aria-label="The verified badge" %} badge is displayed next to the action in {% data variables.product.prodname_marketplace %}.
5+
- **Allow specified actions:** You can restrict workflows to use actions in specific organizations and repositories.
6+
7+
To restrict access to specific tags or commit SHAs of an action, use the same `<OWNER>/<REPO>@<TAG OR SHA>` syntax used in the workflow to select the action. For example, `actions/javascript-action@v1.0.1` to select a tag or `actions/javascript-action@172239021f7ba04fe7327647b213799853a9eb89` to select a SHA. For more information, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions#using-release-management-for-your-custom-actions)."
8+
9+
You can use the `*` wildcard character to match patterns. For example, to allow all actions in organizations that start with `space-org`, you can specify `space-org*/*`. To add all actions in repositories that start with octocat, you can use `*/octocat*@*`. For more information about using the `*` wildcard, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)."
10+
11+
{% if currentVersion == "free-pro-team@latest" %}
12+
{% note %}
13+
14+
**Note:** The **Allow specified actions** option is only available in public repositories with the {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, or {% data variables.product.prodname_team %} plan.
15+
16+
{% endnote %}
17+
{% endif %}
18+
19+
This procedure demonstrates how to add specific actions to the allow list.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
1. Under "Policies", select an option.
2-
![Enable, disable, or limits actions for this enterprise account](/assets/images/help/settings/actions-enable-enterprise-account.png)
2+
![Enable, disable, or limits actions for this enterprise account](/assets/images/help/organizations/enterprise-actions-policy.png)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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.

package-lock.json

Lines changed: 0 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)