Access to reusable workflows
A reusable workflow can be used by another workflow if any of the following is true:
- Both workflows are in the same repository.
- The called workflow is stored in a public repository, and your enterprise allows you to use public reusable workflows.
- The called workflow is stored in an internal repository and the settings for that repository allow it to be accessed. For more information, see Совместное использование действий и рабочих процессов с вашим предприятием.
- The called workflow is stored in a private repository and the settings for that repository allow it to be accessed. For more information, see Совместное использование действий и рабочих процессов с вашим предприятием.
The following table shows the accessibility of reusable workflows to a caller workflow, depending on the visibility of the host repository.
| Caller repository | Accessible workflows repositories |
|---|---|
private | private, internal, and public |
internal | internal, and public |
public | public |
The Actions permissions on the callers repository's Actions settings page must be configured to allow the use of actions and reusable workflows - see Управление параметрами GitHub Actions для репозитория.
For internal or private repositories, the Access policy on the Actions settings page of the called workflow's repository must be explicitly configured to allow access from repositories containing caller workflows - see Управление параметрами GitHub Actions для репозитория.
Примечание.
Для повышения безопасности GitHub Actions не поддерживает перенаправления для действий или повторно используемых рабочих процессов. Это означает, что при изменении владельца, имени репозитория действия или имени действия все рабочие процессы, использующие это действие с предыдущим именем, завершаются ошибкой.
Limitations
-
You can connect up to four levels of workflows. For more information, see Nesting reusable workflows.
-
You can call a maximum of 20 unique reusable workflows from a single workflow file. This limit includes any trees of nested reusable workflows that may be called starting from your top-level caller workflow file.
For example, top-level-caller-workflow.yml → called-workflow-1.yml → called-workflow-2.yml counts as 2 reusable workflows.
-
Any environment variables set in an
envcontext defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information, see Хранение сведений в переменных and Справочник по контекстам. -
Similarly, environment variables set in the
envcontext, defined in the called workflow, are not accessible in theenvcontext of the caller workflow. Instead, you must use outputs of the reusable workflow. For more information, see Using outputs from a reusable workflow. -
To reuse variables in multiple workflows, set them at the organization, repository, or environment levels and reference them using the
varscontext. For more information see Хранение сведений в переменных and Справочник по контекстам. -
Reusable workflows are called directly within a job, and not from within a job step. You cannot, therefore, use
GITHUB_ENVto pass values to job steps in the caller workflow.
Supported keywords for jobs that call a reusable workflow
When you call a reusable workflow, you can only use the following keywords in the job containing the call:
-
Примечание.
- If
jobs.<job_id>.permissionsis not specified in the calling job, the called workflow will have the default permissions for theGITHUB_TOKEN. For more information, see справочник по GITHUB_TOKEN. - The
GITHUB_TOKENpermissions passed from the caller workflow can be only downgraded (not elevated) by the called workflow. - If you use
jobs.<job_id>.concurrency.cancel-in-progress: true, don't use the same value forjobs.<job_id>.concurrency.groupin the called and caller workflows as this will cause the workflow that's already running to be cancelled. A called workflow uses the name of its caller workflow in ${{ github.workflow }}, so using this context as the value ofjobs.<job_id>.concurrency.groupin both caller and called workflows will cause the caller workflow to be cancelled when the called workflow runs.
- If
How reusable workflows use runners
GitHub-hosted runners
The assignment of GitHub-hosted runners is always evaluated using only the caller's context. Billing for GitHub-hosted runners is always associated with the caller. The caller workflow cannot use GitHub-hosted runners from the called repository. For more information, see О средствах выполнения, размещенных в GitHub.
Self-hosted runners
Called workflows that are owned by the same user or organization or enterprise as the caller workflow can access self-hosted runners from the caller's context. This means that a called workflow can access self-hosted runners that are:
- In the caller repository
- In the caller repository's organization or enterprise, provided that the runner has been made available to the caller repository
Access and permissions for nested workflows
A workflow that contains nested reusable workflows will fail if any of the nested workflows is inaccessible to the initial caller workflow. For more information, see Access to reusable workflows.
GITHUB_TOKEN permissions can only be the same or more restrictive in nested workflows. For example, in the workflow chain A > B > C, if workflow A has package: read token permission, then B and C cannot have package: write permission. For more information, see Использование GITHUB_TOKEN в рабочих процессах.
For information on how to use the API to determine which workflow files were involved in a particular workflow run, see Reuse workflows.
Behavior of reusable workflows when re-running jobs
Ссылки на многократно используемые рабочие процессы из общедоступных репозиториев могут указывать код SHA, тег выпуска или имя ветви. Дополнительные сведения см. в разделе Reuse workflows.
При повторном запуске рабочего процесса, в котором есть ссылка на повторно используемый рабочий процесс, формат которой отличен от SHA, следует учитывать важные особенности поведения.
- Повторное выполнение всех заданий в рабочем процессе будет использовать повторно используемый рабочий процесс, на который предоставлена ссылка. Дополнительные сведения о повторном выполнении всех заданий в рабочем процессе см. в разделе Повторный запуск рабочих процессов и заданий.
- Повторное выполнение завершившихся неудачей заданий или конкретного задания в рабочем процессе выполняется с помощью повторно используемого рабочего процесса в том же SHA фиксации, который использовался для первой попытки. Дополнительные сведения о повторном выполнении неудачных заданий в рабочем процессе см. в разделе Повторный запуск рабочих процессов и заданий. Дополнительные сведения о повторном выполнении определенного задания в рабочем процессе см. в разделе Повторный запуск рабочих процессов и заданий.
github context
When a reusable workflow is triggered by a caller workflow, the github context is always associated with the caller workflow. The called workflow is automatically granted access to github.token and secrets.GITHUB_TOKEN. For more information about the github context, see Справочник по контекстам.