0e17f92559
Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> Co-authored-by: Jyotsna <Josh-01@github.com>
2.8 KiB
title, shortTitle, intro, miniTocMaxHeadingLevel, versions, type, topics
| title | shortTitle | intro | miniTocMaxHeadingLevel | versions | type | topics | |||
|---|---|---|---|---|---|---|---|---|---|
| Required workflows | Required workflows | You can specify which workflows will run as required status checks in all repositories or selected repositories in your organization. | 3 |
|
how_to |
|
{% data reusables.actions.workflows.required-workflow-beta %}
Overview
You can configure a workflow that must run in repositories in an organization for all pull requests opened against the default branch. Required workflows allow you to implement organization-wide CI/CD policies that apply to current and future repositories. A required workflow is triggered by pull request events and appears as a required status check, which blocks the ability to merge the pull request until the required workflow succeeds.
Required workflows are not the same as reusable workflows. Reusable workflows can be called by another workflow. Required workflows are enforced on repositories by an organization owner.
Prerequisites
Before configuring a required workflow, note the following prerequisites:
{% data reusables.actions.workflows.required-workflow-prerequisites %}
Restrictions and behaviors for the source repository
Note the following restrictions and behaviors for the source repository and workflow:
{% data reusables.actions.workflows.required-workflow-source-notes %}
Restrictions and behaviors for the target repository
Note the following restrictions and behaviors for the target repositories:
{% data reusables.actions.workflows.required-workflow-target-notes %}
Viewing workflow runs for required workflows
After a required workflow has run at least once in a repository, you can view its workflow runs in that repository's "Actions" tab. To make changes to what workflows are configured as required in an organization, you must contact an organization owner. To make changes to a required workflow itself, anyone with write permissions for the repository that contains the required workflow can make changes to it.
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %}
-
In the left sidebar, you can view workflow runs for required workflows under "Required workflows."
Adding a required workflow to an organization
Organization owners can configure required workflows in their organization. For more information, see "Disabling or limiting GitHub Actions for your organization."