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.
Vous ne pouvez pas remplacer la valeur des variables d’environnement par défaut appelées GITHUB_* et RUNNER_*. Actuellement, vous pouvez remplacer la valeur de la variable CI. Toutefois, il n’est pas garanti que cela sera toujours possible. For more information about setting environment variables, see Stocker des informations dans des variables and Workflow commands for 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 | ID de compte de la personne ou de l’application qui a déclenché l’exécution initiale du workflow. Par exemple : 1234567. Notez qu’il diffère du nom d’utilisateur de l’acteur. |
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 Workflow commands for 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 Workflow commands for 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 Workflow commands for GitHub Actions. |
GITHUB_REF | Référence complète de la branche ou de l’étiquette qui a déclenché l’exécution du workflow. Pour les workflows déclenchés par push, il s’agit de la branche ou de la référence d’étiquette qui a été envoyée. Pour les workflows déclenchés par pull_request, il s’agit de la branche de fusion de la requête de tirage. Pour les workflows déclenchés par release, il s’agit de l’étiquette de mise en production créée. Pour les autres déclencheurs, il s’agit de la branche ou de la référence d’étiquette qui a déclenché l’exécution du workflow. Cette variable est définie uniquement si une branche ou une étiquette est disponible pour le type d’événement. La référence donnée est entièrement formée, ce qui signifie que pour les branches, le format est refs/heads/<branch_name>. Pour les événements de demande de tirage (pull request), à l’exception de pull_request_target, le format est refs/pull/<pr_number>/merge. Les événements pull_request_target ont le ref de la branche de base. Pour les balises, le format est refs/tags/<tag_name>. Par exemple : refs/heads/feature-branch-1. |
GITHUB_REF_NAME | Nom de référence court de la branche ou de l’étiquette qui a déclenché l’exécution du workflow. Cette valeur correspond au nom de la branche ou de l’étiquette indiquée sur GitHub. Par exemple : feature-branch-1.Pour les demandes de tirage, le format est <pr_number>/merge. |
GITHUB_REF_PROTECTED | true si les protections de branche ou les ensembles de règles sont configurés pour la référence qui a déclenché l’exécution du flux de travail. |
GITHUB_REF_TYPE | Type de référence qui a déclenché l’exécution du workflow. Les valeurs valides sont branch ou tag. |
GITHUB_REPOSITORY | The owner and repository name. For example, octocat/Hello-World. |
GITHUB_REPOSITORY_ID | ID du dépôt. Par exemple : 123456789. Notez qu’il diffère du nom du dépôt. |
GITHUB_REPOSITORY_OWNER | The repository owner's name. For example, octocat. |
GITHUB_REPOSITORY_OWNER_ID | ID de compte du propriétaire du dépôt. Par exemple : 1234567. Notez qu’il diffère du nom du propriétaire. |
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 | Numéro unique pour chaque exécution de workflow dans un dépôt. Ce numéro ne change pas si vous réexécutez l’exécution de workflow. For example, 1658821493. |
GITHUB_RUN_NUMBER | Numéro unique de chaque exécution d’un workflow particulier dans un dépôt. Ce nombre commence à 1 pour la première exécution du workflow et s’incrémente à chaque nouvelle exécution. Ce numéro ne change pas si vous réexécutez l’exécution de workflow. For example, 3. |
GITHUB_SERVER_URL | The URL of the GitHub server. For example: https://github.com. |
GITHUB_SHA | SHA de commit qui a déclenché le workflow. La valeur de ce SHA de commit dépend de l’événement qui a déclenché le workflow. Pour plus d’informations, consultez « Événements qui déclenchent des flux de travail ». Par exemple : 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 Workflow commands for GitHub Actions. |
GITHUB_TRIGGERING_ACTOR | Nom d’utilisateur de l’utilisateur ayant lancé l’exécution du workflow. Si l’exécution du workflow est une réexécution, cette valeur peut être différente de github.actor. Toutes les réexécutions de workflow utilisent les privilèges de github.actor, même si l’acteur qui initie la réexécution (github.triggering_actor) a des privilèges différents. |
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 | Chemin de référence du workflow. Par exemple : octocat/hello-world/.github/workflows/my-workflow.yml@refs/heads/my_branch. |
GITHUB_WORKFLOW_SHA | SHA de commit pour le fichier de workflow. |
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 | Architecture de l’exécuteur qui exécute le travail. Les valeurs possibles sont X86, X64, ARM ou ARM64. |
RUNNER_DEBUG | Cela est défini seulement si la journalisation du débogage est activée et a toujours la valeur 1. À titre indicatif, il peut être utile d’activer un débogage supplémentaire ou une journalisation détaillée dans vos propres étapes de travail. |
RUNNER_ENVIRONMENT | L’environnement de l’exécuteur de la tâche. Les valeurs possibles sont les suivantes : github-hosted pour les exécuteurs hébergés par GitHub fournis par GitHub et self-hosted pour les exécuteurs auto-hébergés configurés par le propriétaire du référentiel. |
RUNNER_NAME | Nom de l’exécuteur du travail. Ce nom peut ne pas être unique dans l’exécution d’un flux de travail, car les exécutants au niveau du référentiel et de l'organisation peuvent utiliser le même nom. For example, Hosted Agent |
RUNNER_OS | Système d’exploitation de l’exécuteur du travail. Les valeurs possibles sont Linux, Windows ou macOS. For example, Windows |
RUNNER_TEMP | Chemin d’un répertoire temporaire sur l’exécuteur. Ce répertoire est vidé au début et à la fin de chaque travail. Notez que les fichiers ne sont pas supprimés si le compte d’utilisateur de l’exécuteur n’a pas l’autorisation de les supprimer. For example, D:\a\_temp |
RUNNER_TOOL_CACHE | Chemin du répertoire contenant des outils préinstallés pour les exécuteurs hébergés par GitHub. Pour plus d’informations, consultez « Utilisation des exécuteurs hébergés par GitHub ». For example, C:\hostedtoolcache\windows |
Remarque
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:
- Peuvent uniquement contenir des caractères alphanumériques (
[a-z],[A-Z],[0-9]) ou des traits de soulignement (_). Les espaces ne sont pas autorisés. - Ne doit pas commencer par le préfixe
GITHUB_. - Ne doit pas commencer par un chiffre.
- Ne sont pas sensibles à la casse lorsqu’ils sont référencés. GitHub enregistre les noms de secrets en majuscules, quelle que soit la façon dont ils sont entrés.
- Doivent être uniques au référentiel, à l’organisation ou à l’entreprise où ils sont créés.
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.
Remarque
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.
Remarque
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.
Avertissement
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 }} |