This article lists the supported variables you can use in GitHub Actions workflows, including environment variables, configuration variables, and default variables provided by GitHub. Use this reference to look up variable names, naming conventions, limits, and supported contexts when configuring your workflows.
For more information about variables, see Variables.
Default environment variables
The default environment variables that GitHub sets are available to every step in a workflow.
Because default environment variables are set by GitHub and not defined in a workflow, they are not accessible through the env context. However, most of the default variables have a corresponding, and similarly named, context property. For example, the value of the GITHUB_REF variable can be read during workflow processing using the ${{ github.ref }} context property.
Нельзя перезаписать значение переменных среды по умолчанию с именем GITHUB_* и RUNNER_*. В настоящее время можно перезаписать значение переменной CI . Однако это не гарантируется, что это всегда будет возможно. For more information about setting environment variables, see Хранение сведений в переменных and Команды рабочего процесса для GitHub Actions.
We strongly recommend that actions use variables to access the filesystem rather than using hardcoded file paths. GitHub sets variables for actions to use in all runner environments.
| Variable | Description |
|---|---|
CI | Always set to true. |
GITHUB_ACTION | The name of the action currently running, or the id of a step. For example, for an action, __repo-owner_name-of-action-repo.GitHub removes special characters, and uses the name __run when the current step runs a script without an id. If you use the same script or action more than once in the same job, the name will include a suffix that consists of the sequence number preceded by an underscore. For example, the first script you run will have the name __run, and the second script will be named __run_2. Similarly, the second invocation of actions/checkout will be actionscheckout2. |
GITHUB_ACTION_PATH | The path where an action is located. This property is only supported in composite actions. You can use this path to change directories to where the action is located and access other files in that same repository. For example, /home/runner/work/_actions/repo-owner/name-of-action-repo/v1. |
GITHUB_ACTION_REPOSITORY | For a step executing an action, this is the owner and repository name of the action. For example, actions/checkout. |
GITHUB_ACTIONS | Always set to true when GitHub Actions is running the workflow. You can use this variable to differentiate when tests are being run locally or by GitHub Actions. |
GITHUB_ACTOR | The name of the person or app that initiated the workflow. For example, octocat. |
GITHUB_ACTOR_ID | Идентификатор учетной записи пользователя или приложения, активировавшего начальное выполнение рабочего процесса. Например, 1234567. Обратите внимание, что это отличается от имени пользователя субъекта. |
GITHUB_API_URL | Returns the API URL. For example: https://api.github.com. |
GITHUB_BASE_REF | The name of the base ref or target branch of the pull request in a workflow run. This is only set when the event that triggers a workflow run is either pull_request or pull_request_target. For example, main. |
GITHUB_ENV | The path on the runner to the file that sets variables from workflow commands. The path to this file is unique to the current step and changes for each step in a job. For example, /home/runner/work/_temp/_runner_file_commands/set_env_87406d6e-4979-4d42-98e1-3dab1f48b13a. For more information, see Команды рабочего процесса для GitHub Actions. |
GITHUB_EVENT_NAME | The name of the event that triggered the workflow. For example, workflow_dispatch. |
GITHUB_EVENT_PATH | The path to the file on the runner that contains the full event webhook payload. For example, /github/workflow/event.json. |
GITHUB_GRAPHQL_URL | Returns the GraphQL API URL. For example: https://api.github.com/graphql. |
GITHUB_HEAD_REF | The head ref or source branch of the pull request in a workflow run. This property is only set when the event that triggers a workflow run is either pull_request or pull_request_target. For example, feature-branch-1. |
GITHUB_JOB | The job_id of the current job. For example, greeting_job. |
GITHUB_OUTPUT | The path on the runner to the file that sets the current step's outputs from workflow commands. The path to this file is unique to the current step and changes for each step in a job. For example, /home/runner/work/_temp/_runner_file_commands/set_output_a50ef383-b063-46d9-9157-57953fc9f3f0. For more information, see Команды рабочего процесса для GitHub Actions. |
GITHUB_PATH | The path on the runner to the file that sets system PATH variables from workflow commands. The path to this file is unique to the current step and changes for each step in a job. For example, /home/runner/work/_temp/_runner_file_commands/add_path_899b9445-ad4a-400c-aa89-249f18632cf5. For more information, see Команды рабочего процесса для GitHub Actions. |
GITHUB_REF | Полностью сформированный ссылку на ветвь или тег, активировавший выполнение рабочего процесса. Если рабочий процесс запущен по триггеру push, здесь указывается ссылка на отправленную ветвь или тег выпуска. Если рабочий процесс запущен по триггеру pull_request, здесь указывается ветвь слияния для запроса на вытягивание. Если рабочий процесс запущен по триггеру release, здесь указывается созданный тег выпуска. Для всех остальных триггеров указывается ссылка на ветвь или тег, которые активировали запуск рабочего процесса. Это значение задается только для тех типов событий, в которых доступны ветвь или тег. Указанная ссылка полностью сформирована, что означает, что для ветвей имеется refs/heads/<branch_name>формат. Для событий запросов на вытягивание, кроме pull_request_targetтого, это refs/pull/<pr_number>/merge. pull_request_targetсобытия имеют базовая ветвьref. Для тегов это refs/tags/<tag_name>. Например, refs/heads/feature-branch-1. |
GITHUB_REF_NAME | Короткое имя ссылки ветви или тега, активировав выполнение рабочего процесса. Это значение соответствует имени ветви или тега, отображаемого на GitHub. Например, feature-branch-1.Для запросов на вытягивание используется <pr_number>/mergeформат. |
GITHUB_REF_PROTECTED | true Значение , если защита ветви или наборы правил настроены для ссылки, которая активировала выполнение рабочего процесса. |
GITHUB_REF_TYPE | Тип ссылки, активировавшей выполнение рабочего процесса. Допустимые значения — branch или tag. |
GITHUB_REPOSITORY | The owner and repository name. For example, octocat/Hello-World. |
GITHUB_REPOSITORY_ID | Идентификатор репозитория. Например, 123456789. Обратите внимание, что это отличается от имени репозитория. |
GITHUB_REPOSITORY_OWNER | The repository owner's name. For example, octocat. |
GITHUB_REPOSITORY_OWNER_ID | Идентификатор учетной записи владельца репозитория. Например, 1234567. Обратите внимание, что это отличается от имени владельца. |
GITHUB_RETENTION_DAYS | The number of days that workflow run logs and artifacts are kept. For example, 90. |
GITHUB_RUN_ATTEMPT | A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the workflow run's first attempt, and increments with each re-run. For example, 3. |
GITHUB_RUN_ID | Уникальный номер каждого запуска рабочего процесса в репозитории. Он не изменяется при повторном запуске рабочего процесса. For example, 1658821493. |
GITHUB_RUN_NUMBER | Уникальный номер для каждого запуска определенного рабочего процесса в репозитории. Он начинается с цифры 1 для первого запуска рабочего процесса и увеличивается с каждым новым запуском. Он не изменяется при повторном запуске рабочего процесса. For example, 3. |
GITHUB_SERVER_URL | The URL of the GitHub server. For example: https://github.com. |
GITHUB_SHA | SHA фиксации, инициировавшей рабочий процесс. Значение этой фиксации SHA зависит от события, активирующего рабочий процесс. Дополнительные сведения см. в разделе События, инициирующие рабочие процессы. Например, ffac537e6cbbf934b08745a378932722df287a53. |
GITHUB_STEP_SUMMARY | The path on the runner to the file that contains job summaries from workflow commands. The path to this file is unique to the current step and changes for each step in a job. For example, /home/runner/_layout/_work/_temp/_runner_file_commands/step_summary_1cb22d7f-5663-41a8-9ffc-13472605c76c. For more information, see Команды рабочего процесса для GitHub Actions. |
GITHUB_TRIGGERING_ACTOR | Имя пользователя, запустившего экземпляр рабочего процесса. Если рабочий процесс выполняется повторно, это значение может отличаться от github.actor. В повторных запусках рабочих процессов будут использоваться привилегии github.actor, даже если субъект, инициировавший повторный запуск (github.triggering_actor), имеет другие привилегии. |
GITHUB_WORKFLOW | The name of the workflow. For example, My test workflow. If the workflow file doesn't specify a name, the value of this variable is the full path of the workflow file in the repository. |
GITHUB_WORKFLOW_REF | Путь ссылки к рабочему процессу. Например, octocat/hello-world/.github/workflows/my-workflow.yml@refs/heads/my_branch. |
GITHUB_WORKFLOW_SHA | Фиксация SHA для файла рабочего процесса. |
GITHUB_WORKSPACE | The default working directory on the runner for steps, and the default location of your repository when using the checkout action. For example, /home/runner/work/my-repo-name/my-repo-name. |
RUNNER_ARCH | Архитектура средства выполнения задания. Возможные значения: X86, X64, ARM или ARM64. |
RUNNER_DEBUG | Это делается только в том случае, если ведение журнала отладки включено и всегда имеет значение 1. Это может быть полезно в качестве индикатора для включения дополнительной отладки или подробного ведения журнала в ваших шагах задания. |
RUNNER_ENVIRONMENT | Среда выполнения задания. Возможные значения: github-hosted для управляемых GitHub средств выполнения, предоставляемых GitHub, а self-hosted также для локальных модулей выполнения, настроенных владельцем репозитория. |
RUNNER_NAME | Имя средства выполнения задания. Это имя может не быть уникальным в рабочем процессе, выполняемом в качестве средств выполнения на уровне репозитория и организации, может использовать то же имя. For example, Hosted Agent |
RUNNER_OS | Операционная система средства выполнения тестов, выполняющего задание. Возможные значения: Linux, Windowsили macOS. For example, Windows |
RUNNER_TEMP | Путь к временному каталогу в средстве выполнения. Этот каталог очищается в начале и конце каждого задания. Обратите внимание, что файлы не удаляются, если у учетной записи пользователя средства выполнения нет разрешения на их удаление. For example, D:\a\_temp |
RUNNER_TOOL_CACHE | Путь к каталогу, содержащему предустановленные средства для размещенных в GitHub средств выполнения. Дополнительные сведения см. в разделе Использование средств выполнения, размещенных в GitHub. For example, C:\hostedtoolcache\windows |
Примечание.
If you need to use a workflow run's URL from within a job, you can combine these variables: $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID
Naming conventions for configuration variables
The following rules apply to configuration variable names:
- Может содержать только буквенно-цифровые символы (
[a-z],[A-Z],[0-9]) или символы подчеркивания (_). Пробелы недопустимы. - не должно начинаться с префикса
GITHUB_; - не должно начинаться с цифры.
- Не учитывается регистр при ссылке. GitHub сохраняет имена секретов в виде верхнего регистра независимо от того, как они введены.
- Должен быть уникальным для репозитория, организации или предприятия, где они создаются.
Naming conventions for environment variables
When you set an environment variable, you cannot use any of the default environment variable names. For a complete list of default environment variables, see Variables reference below. If you attempt to override the value of one of these default variables, the assignment is ignored.
Примечание.
You can list the entire set of environment variables that are available to a workflow step by using run: env in a step and then examining the output for the step.
Configuration variable precedence
If a variable with the same name exists at multiple levels, the variable at the lowest level takes precedence. For example, if an organization-level variable has the same name as a repository-level variable, then the repository-level variable takes precedence. Similarly, if an organization, repository, and environment all have a variable with the same name, the environment-level variable takes precedence.
For reusable workflows, the variables from the caller workflow's repository are used. Variables from the repository that contains the called workflow are not made available to the caller workflow.
Limits for configuration variables
Individual variables are limited to 48 KB in size.
You can store up to 1,000 organization variables, 500 variables per repository, and 100 variables per environment. The total combined size limit for organization and repository variables is 256 KB per workflow run.
A workflow created in a repository can access the following number of variables:
- Up to 500 repository variables, if the total size of repository variables is less than 256 KB. If the total size of repository variables exceeds 256 KB, only the repository variables that fall below the limit will be available (as sorted alphabetically by variable name).
- Up to 1,000 organization variables, if the total combined size of repository and organization variables is less than 256 KB. If the total combined size of organization and repository variables exceeds 256 KB, only the organization variables that fall below that limit will be available (after accounting for repository variables and as sorted alphabetically by variable name).
- Up to 100 environment-level variables.
Примечание.
Environment-level variables do not count toward the 256 KB total size limit. If you exceed the combined size limit for repository and organization variables and still need additional variables, you can use an environment and define additional variables in the environment.
Supported contexts
You will commonly use either the env or github context to access variable values in parts of the workflow that are processed before jobs are sent to runners.
Предупреждение
Do not print the github context to logs. It contains sensitive information.
| Context | Use case | Example |
|---|---|---|
env | Reference custom variables defined in the workflow. | ${{ env.MY_VARIABLE }} |
github | Reference information about the workflow run and the event that triggered the run. | ${{ github.repository }} |