Variables reference

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 変数.

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 Store information in 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。たとえば、`1234567` のようにします。これはアクターのユーザー名とは異なることに注意してください。
`GITHUB_API_URL`	Returns the API URL. For example: `http(s)://HOSTNAME/api/v3`.
`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: `http(s)://HOSTNAME/api/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`	ワークフローの実行をトリガーしたブランチまたはタグの完全な形式の参照。 `push` によってトリガーされるワークフローの場合、これはプッシュされたブランチまたはタグの参照です。 `pull_request` によってトリガーされるワークフローの場合、これは pull request のマージブランチです。 `release` によってトリガーされるワークフローの場合、これは作成されたリリースタグです。その他のトリガーの場合、これはワークフロー実行をトリガーしたブランチまたはタグの参照です。これは、イベントの種類に対してブランチまたはタグを使用できる場合にのみ設定されます。この参照は完全な形式です。つまり、ブランチの場合の形式は `refs/heads/<branch_name>` です。 `pull_request_target` 以外の pull request イベントの場合は `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` のようにします。 pull request の場合、形式は `<pr_number>/merge`。
`GITHUB_REF_PROTECTED`	`true` 分岐保護が、ワークフロー実行をトリガーした ref に対して構成されている場合。
`GITHUB_REF_TYPE`	ワークフローの実行をトリガーした ref の種類。有効な値は `branch` または `tag`です。
`GITHUB_REPOSITORY`	The owner and repository name. For example, `octocat/Hello-World`.
`GITHUB_REPOSITORY_ID`	リポジトリの ID。たとえば、「 `123456789` 」のように入力します。これはリポジトリ名とは異なることに注意してください。
`GITHUB_REPOSITORY_OWNER`	The repository owner's name. For example, `octocat`.
`GITHUB_REPOSITORY_OWNER_ID`	リポジトリ所有者のアカウント 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://HOSTNAME`.
`GITHUB_SHA`	ワークフローをトリガーしたコミット SHA。このコミット SHA の値は、ワークフローをトリガーしたイベントによって異なります。詳しくは、「Events that trigger workflows」をご覧ください。たとえば、 `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`	ワークフローの実行を開始したユーザーのユーザー名。ワークフローの実行が再実行である場合、この値は `github.actor` と異なることがあります。ワークフローのすべての再実行では、再実行を開始したアクター (`github.triggering_actor`) が異なる特権を持っている場合であっても、`github.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 によって提供される GitHub でホストされたランナーの場合は `github-hosted`、リポジトリのオーナーによって構成されたセルフホステッドランナーの場合は `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-hosted runners」をご覧ください。 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 は、入力方法に関係なく、シークレット名を大文字として格納します。
作成されたリポジトリ、organization、または Enterprise に固有のものにする必要があります。

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 10 MB 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 10 MB. If the total size of repository variables exceeds 10 MB, 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 10 MB. If the total combined size of organization and repository variables exceeds 10 MB, 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 10 MB 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 }}`