Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions content/actions/concepts/about-actions-policies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: About Actions policies
shortTitle: Policies
intro: Govern how {% data variables.product.prodname_actions %} workflows run within your repository, organization, or enterprise.
versions:
feature: workflow-execution-protections
contentType: concepts
redirect_from:
- /repositories/managing-your-repositorys-settings-and-features/actions-policies/about-actions-policies
- /organizations/managing-organization-settings/actions-policies/about-actions-policies
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/actions-policies/about-actions-policies
- /repositories/managing-your-repositorys-settings-and-features/actions-policies
- /organizations/managing-organization-settings/actions-policies
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/actions-policies
---

## About Actions policies

Actions policies let you govern how {% data variables.product.prodname_actions %} workflows run. You can configure them in the **Policies** section of your {% data variables.product.prodname_actions %} settings (separate from the **General** settings).

Actions policies are available at the enterprise, organization, and repository levels. They currently contain one type of policy: workflow execution protections. {% data variables.product.github %} plans to add more policies over time.

## About workflow execution protections

{% data reusables.actions.actions-policies-about-body %} These protections can disrupt several real-world attack patterns:

* **Poisoned pipeline execution from pull requests.** Restrict or prohibit `pull_request_target`, including in public repositories where it is most often exploited.
* **Manual-trigger abuse.** Limit `workflow_dispatch` so untrusted identities cannot start workflows.
* **Untrusted-actor execution.** Block low-trust identities from triggering workflows entirely.
* **Misconfiguration exploitation.** Apply central policy that overrides any single misconfigured workflow file.

When enforced, disallowed workflow runs will fail with an error. For example:

``` text
Event 'workflow_dispatch' is not allowed to trigger Actions workflows. Workflow file: '.github/workflows/0-welcome.yml'.
```

<!-- expires 2026-11-02 -->

{% ifversion default-pull-req-target-policy %}

> [!NOTE] {% data reusables.actions.workflows.pull-request-target-policy %}

{% endif %}

<!-- end expires 2026-11-02 -->

### Available rules

* **Actor rules** control who can trigger workflows, including individual users, repository roles, {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_copilot_short %}, and {% data variables.product.prodname_dependabot %}. By default, every user with write access to a repository can trigger workflows. Actor rules let you separate who contributes code from who runs your CI, so you can grant a contributor write access without granting them the ability to execute workflows.
* **Event rules** control which events are permitted, such as `push`, `pull_request`, `pull_request_target`, and `workflow_dispatch`.

{% data variables.product.github %} plans to add more rules over time.

## Next steps

To configure workflow execution protections, see [AUTOTITLE](/actions/how-tos/administer/control-workflow-execution).

To manage policies programmatically, see [AUTOTITLE](/rest/actions/policies).
1 change: 1 addition & 0 deletions content/actions/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ children:
- /security
- /metrics
- /billing-and-usage
- /about-actions-policies
redirect_from:
- /actions/concepts/use-cases
contentType: concepts
Expand Down
85 changes: 85 additions & 0 deletions content/actions/how-tos/administer/control-workflow-execution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: Controlling who can execute {% data variables.product.prodname_actions %} workflows
shortTitle: Control workflow execution
intro: Control who can trigger {% data variables.product.prodname_actions %} workflows and which events are permitted to run them across an enterprise, organization, and repository.
versions:
feature: workflow-execution-protections
contentType: how-tos
redirect_from:
- /repositories/managing-your-repositorys-settings-and-features/actions-policies/workflow-execution-protections
- /organizations/managing-organization-settings/actions-policies/workflow-execution-protections
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/actions-policies/workflow-execution-protections
permissions: 'Repository administrators, organization owners, and enterprise owners'
product: 'All public repositories, and private repositories on {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %}.'
---

{% data reusables.actions.actions-policies-about-body %} For more information, see [AUTOTITLE](/actions/concepts/about-actions-policies).

<!-- expires 2026-11-02 -->

{% ifversion default-pull-req-target-policy %}

> [!NOTE] {% data reusables.actions.workflows.pull-request-target-policy %}

{% endif %}

<!-- end expires 2026-11-02 -->

## Preparing to add protections

Like rulesets, workflow execution protections layer with other protections in the same repository, organization, or enterprise.

Rather than creating one large policy per account, we recommend creating multiple clearly defined policies and layering protections across account levels. Enterprise owners can create protections at the enterprise level for broad, non-negotiable policies. Organization owners and repository administrators can then add to these restrictions.

For each policy you define, think about:

1. **Which organizations or repositories** your protection will target. For example, open source repositories may need tighter restrictions on who can trigger workflows. You can target repositories by factors like visibility, deployment status, or custom property.

* Deployment status comes from an organization's {% data variables.product.virtual_registry %}. If this is an important factor, make sure you're uploading deployment records when an artifact is deployed. See [AUTOTITLE](/code-security/concepts/supply-chain-security/linked-artifacts).
* To create and assign custom properties, see [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization).

1. **Which workflows** will be protected. For example, workflows that deploy production code might need a certain level of protection, but less sensitive automations may not need the same level of protection. You can scope policies to specific workflow paths or required workflows.
1. **Who should be able to run these workflows** in the repositories you're targeting. This might be users with a certain role, selected bot accounts, or a specific team. Consider grouping these users in an organization or enterprise team so they can be easily contacted and referenced across multiple rulesets. See [AUTOTITLE](/organizations/organizing-members-into-teams/creating-a-team) or [AUTOTITLE](/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/create-enterprise-teams).

## Creating a workflow execution policy

First, create a new Actions policy for the account level you're working at.

In a repository or organization:

1. Click the **Settings** tab.
1. In the left sidebar, under **Actions**, click **Policies**.

In an enterprise:

1. Click the **{% octicon "law" aria-hidden="true" aria-label="law" %} Policies** tab.
1. In the left sidebar, click **Actions**, then **Policies**.

> [!TIP] To manage policies programmatically, see [AUTOTITLE](/rest/actions/policies).

### Configuring the policy

Next, create a new policy.

1. Choose a name for the policy.
1. Choose an enforcement status. If you select **Evaluate** ({% data variables.product.prodname_ghe_cloud %} only), you will be able to monitor when users would hit the restriction in policy insights.
1. Target your desired workflows, organizations, or repositories.
1. Configure the following workflow execution protections.

### Restrict actors

By default, every user with write access to a repository can trigger workflows. Actor rules let you separate who contributes code from who runs your CI, so you can grant a contributor write access without granting them the ability to execute workflows.

Only the allowed actors will be able to run the specified workflows in the targeted repository. If you also restrict events, these users will only be able to trigger workflows with the allowed events. Non-allowed actors will not be able to run the specified workflows at all.

{% data variables.product.github %} features are exempt from these restrictions for the built-in processes that they run on {% data variables.product.prodname_actions %}. However, if you have created workflows that need to be run by the identity associated with a {% data variables.product.github %} feature, such as `dependabot[bot]`, then this identity must be added as an allowed actor.

### Restrict events

Event rules control which events are permitted, such as `push`, `pull_request`, `pull_request_target`, and `workflow_dispatch`.

## Evaluating policies

You can view policy insights to see workflow runs that have been blocked (for active policies) or would have been blocked (for "evaluate" policies). This is a good way to check that policies are working as intended and not causing unnecessary friction.

To view insights, click the **Policy insights** page. You'll find this directly under the page for {% data variables.product.prodname_actions %} policies in your repository, organization, or enterprise sidebar.
1 change: 1 addition & 0 deletions content/actions/how-tos/administer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ versions:
ghes: '*'
ghec: '*'
children:
- /control-workflow-execution
- /view-metrics
- /reuse-namespaces-on-ghecom
redirect_from:
Expand Down
Loading
Loading