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.
Du kannst den Wert der Standardumgebungsvariablen namens GITHUB_*
und RUNNER_*
nicht überschreiben. Derzeit kannst du den Wert der Variablen CI
überschreiben. Es ist jedoch nicht garantiert, dass dies immer möglich sein wird. For more information about setting environment variables, see Speichern von Informationen in Variablen and Workflow commands for GitHub Actions (Workflowbefehle für 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 | Die Konto-ID der Person oder App, die die ursprüngliche Workflowausführung ausgelöst hat. Beispiel: 1234567 . Beachte, dass sie sich vom Benutzernamen des Akteurs unterscheidet. |
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 (Workflowbefehle für 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 (Workflowbefehle für 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 (Workflowbefehle für GitHub Actions). |
GITHUB_REF | Das vollständig geformte Ref des Branch- oder Tagnamens, der die Workflowausführung ausgelöst hat. Bei Workflows, die durch push ausgelöst wurden, ist dies das Branch- oder Tag-Ref, das gepusht wurde. Bei Workflows, die von pull_request ausgelöst werden, ist dies der Branch für das Mergen des Pull Requests. Bei Workflows, die von release ausgelöst werden, ist dies das erstellte Releasetag. Bei anderen Triggern handelt es sich um das Branch- oder Tag-Ref, das die Workflowausführung ausgelöst hat. Es wird nur festgelegt, wenn für den Ereignistyp ein Branch oder ein Tag verfügbar ist. Der angegebene Bezug ist vollständig formatiert, d. h. für Branches ist refs/heads/<branch_name> das Format. Bei Pull-Request-Ereignissen mit Ausnahme von pull_request_target lautet dieser refs/pull/<pr_number>/merge . pull_request_target -Ereignisse haben ref aus dem Basisbranch. Für Tags ist es refs/tags/<tag_name> . Beispiel: refs/heads/feature-branch-1 . |
GITHUB_REF_NAME | Der kurze Ref-Name des Branches oder Tags, der bzw. das die Workflowausführung ausgelöst hat. Dieser Wert entspricht dem Branch- oder Tagnamen, der auf GitHub angezeigt wird. Beispiel: feature-branch-1 .Für Pull Requests ist das Format <pr_number>/merge . |
GITHUB_REF_PROTECTED | true wenn Verzweigungsschutz oder Rulesets für den Verweis konfiguriert sind, der die Workflow-Ausführung ausgelöst hat. |
GITHUB_REF_TYPE | Der Typ des Verweises, der die Workflowausführung ausgelöst hat. Gültige Werte sind branch und tag . |
GITHUB_REPOSITORY | The owner and repository name. For example, octocat/Hello-World . |
GITHUB_REPOSITORY_ID | Die ID des Repositorys. Beispiel: 123456789 . Beachte, dass sie sich vom Repositorynamen unterscheidet. |
GITHUB_REPOSITORY_OWNER | The repository owner's name. For example, octocat . |
GITHUB_REPOSITORY_OWNER_ID | Die Konto-ID des Repositorybesitzers bzw. der Repositorybesitzerin. Beispiel: 1234567 . Beachte, dass sie sich vom Besitzernamen unterscheidet. |
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 | Eine eindeutige Zahl für jeden Workflow, der innerhalb eines Repositorys ausgeführt wird. Diese Nummer ändert sich nicht, wenn Du den Workflowablauf erneut ausführst. For example, 1658821493 . |
GITHUB_RUN_NUMBER | Eine eindeutige Nummer für jede Ausführung eines bestimmten Workflows in einem Repository. Diese Zahl beginnt bei 1 für die erste Ausführung des Workflows und wird bei jeder neuen Ausführung erhöht. Diese Nummer ändert sich nicht, wenn Du den Workflowablauf erneut ausführst. For example, 3 . |
GITHUB_SERVER_URL | The URL of the GitHub server. For example: https://github.com . |
GITHUB_SHA | Der Commit-SHA-Wert, der den Workflow ausgelöst hat. Dieser Wert hängt von dem Ereignis ab, das den Workflow ausgelöst hat. Weitere Informationen finden Sie unter Ereignisse zum Auslösen von Workflows. Beispiel: 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 (Workflowbefehle für GitHub Actions). |
GITHUB_TRIGGERING_ACTOR | Benutzername des Benutzers bzw. der Benutzerin, der bzw. die die Workflowausführung initiiert hat. Wenn die Workflowausführung eine erneute Ausführung ist, unterscheidet sich dieser Wert möglicherweise von github.actor . Alle Workflowneuausführungen verwenden die Berechtigungen von github.actor , auch wenn der Akteur bzw. die Akteurin, der/die die Neuausführung (github.triggering_actor ) initiiert, unterschiedliche Berechtigungen hat. |
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 | Der Verweispfad zum Workflow. Beispiel: octocat/hello-world/.github/workflows/my-workflow.yml@refs/heads/my_branch . |
GITHUB_WORKFLOW_SHA | Der Commit-SHA für die Workflowdatei. |
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 | Die Architektur des Runners, der den Auftrag ausführt. Mögliche Werte sind X86 , X64 , ARM oder ARM64 . |
RUNNER_DEBUG | Dies ist nur festgelegt, wenn die Debugprotokollierung aktiviert ist, und weist immer den Wert 1 auf. Es kann ein nützlicher Hinweis darauf sein, ob in deinen Auftragsschritten zusätzliches Debugging oder eine ausführliche Protokollierung aktiviert werden sollte. |
RUNNER_ENVIRONMENT | Die Umgebung des Runners, der den Auftrag ausführt. Mögliche Werte sind github-hosted für von GitHub gehostete Runner, die von GitHub bereitgestellt werden, und self-hosted für selbst gehostete Runner, die vom Repositorybesitzer konfiguriert werden. |
RUNNER_NAME | Der Name des Runners, der den Auftrag ausführt. Dieser Name ist in einem Workflow-Lauf möglicherweise nicht eindeutig, da Runner auf Repository- und Organisationsebene denselben Namen verwenden könnten. For example, Hosted Agent |
RUNNER_OS | Das Betriebssystem des Runners, der den Job ausführt. Mögliche Werte sind Linux , Windows oder macOS . For example, Windows |
RUNNER_TEMP | Der Pfad zu einem temporären Verzeichnis im Runner. Dieses Verzeichnis wird jeweils zu Beginn und am Ende eines Auftrags geleert. Hinweis: Wenn das Benutzerkonto des Runners über keine Berechtigung zum Löschen verfügt, werden keine Dateien entfernt. For example, D:\a\_temp |
RUNNER_TOOL_CACHE | Der Pfad zu dem Verzeichnis, das vorinstallierte Tools für von GitHub gehostete Runner enthält. Weitere Informationen finden Sie unter Verwenden von auf GitHub gehosteten Runnern. For example, C:\hostedtoolcache\windows |
Hinweis
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:
- Darf nur alphanumerische Zeichen (
[a-z]
,[A-Z]
,[0-9]
) oder Unterstriche (_
) enthalten Leerzeichen sind nicht zulässig. - darf nicht mit dem
GITHUB_
-Präfix beginnen. - darf nicht mit einer Zahl beginnen.
- Bei Verweisen wird die Groß-/Kleinschreibung nicht beachtet. GitHub speichert Geheimnisnamen unabhängig davon, wie sie eingegeben werden.
- Müssen für das Repository, die Organisation oder das Unternehmen eindeutig sein, in dem bzw. der sie erstellt werden
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.
Hinweis
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.
Hinweis
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.
Warnung
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 }} |