1
0
mirror of synced 2025-12-30 12:02:01 -05:00
Files
docs/data/reusables/actions/workflows/required-workflow-source-notes.md

2.5 KiB

  • Required workflows can be stored in any repository folder and are not restricted to the .github/workflows folder like normal workflows. If a required workflow calls a reusable workflow, the reusable workflow must be stored in the .github/workflows folder. When calling a reusable workflow, a required workflow must use the full path and ref to the reusable workflow. For example, {owner}/{repo}/.github/workflows/{filename}@{ref}.
  • If the required workflow is contained in a private {% ifversion ghes or ghec %}or internal {% endif %}repository, you must ensure that workflows within the repository are accessible by other repositories in your organization. For more information, see "AUTOTITLE{% ifversion ghes or ghec %}" and "AUTOTITLE{% endif %}."
  • Workflows stored in a public repository can be configured as required workflows for any repository in your organization. Workflows stored in a private repository can only be configured as required workflows for other private repositories in your organization. {% ifversion ghes or ghec %} Workflows stored in internal repositories can be configured as required workflows for internal and private repositories in your organization.{% endif %}
  • {% data variables.product.prodname_codeql %} is not supported in required workflows because {% data variables.product.prodname_codeql %} requires configuration at the repository level. For information on configuring code scanning, see "AUTOTITLE." {% ifversion actions-required-workflow-improvements %} {% ifversion fpt or ghec %}
  • To push to a branch where required workflows are enforced at the organizational level, create a pull request to make the necessary changes. You cannot push directly to branches with required workflow enforcements.
  • If you want to allow direct pushes for a particular repository, you must remove the repository as a target from respective required workflows. {% endif %}
  • Required workflows can be referenced using any branch, tag, or commit SHA from the repository containing the workflow file. {% endif %}