注: GitHub 托管的运行器目前在 GitHub Enterprise Server 上不受支持。 您可以在 GitHub 公共路线图 上查看有关未来支持计划的更多信息。
关于环境变量
You can use environment variables to store information that you want to reference in your workflow. You reference environment variables within a workflow step or an action, and the variables are interpolated on the runner machine that runs your workflow. Commands that run in actions or workflow steps can create, read, and modify environment variables.
You can set your own custom environment variables, you can use the default environment variables that GitHub sets automatically, and you can also use any other environment variables that are set in the working environment on the runner. 环境变量区分大小写。
To set a custom environment variable, you must define it in the workflow file. The scope of a custom environment variable is limited to the element in which it is defined. You can define environment variables that are scoped for:
- The entire workflow, by using
env
at the top level of the workflow file. - The contents of a job within a workflow, by using
jobs.<job_id>.env
. - A specific step within a job, by using
jobs.<job_id>.steps[*].env
.
name: Greeting on variable day
on:
workflow_dispatch
env:
DAY_OF_WEEK: Monday
jobs:
greeting_job:
runs-on: ubuntu-latest
env:
Greeting: Hello
steps:
- name: "Say Hello Mona it's Monday"
run: echo "$Greeting $First_Name. Today is $DAY_OF_WEEK!"
env:
First_Name: Mona
The example above shows three custom environment variables being used in an echo
command: $DAY_OF_WEEK
, $Greeting
, and $First_Name
. The values for these environment variables are set, and scoped, at the workflow, job, and step level respectively.
Because environment variable interpolation is done after a workflow job is sent to a runner machine, you must use the appropriate syntax for the shell that's used on the runner. In this example, the workflow specifies ubuntu-latest
. By default, Linux runners use the bash shell, so you must use the syntax $NAME
. If the workflow specified a Windows runner, you would use the syntax for PowerShell, $env:NAME
. For more information about shells, see "Workflow syntax for GitHub Actions."
Note: 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.
Using contexts to access environment variable values
In addition to environment variables, GitHub Actions also allows you to set and read values using contexts. Environment variables and contexts are intended for use at different points in the workflow.
Environment variables are always interpolated on the virtual machine runner. However, parts of a workflow are processed by GitHub Actions and are not sent to the runner. You cannot use environment variables in these parts of a workflow file. Instead, you can use contexts. For example, an if
conditional, which determines whether a job or step is sent to the runner, is always processed by GitHub Actions. You can use a context in an if
conditional statement to access the value of an environment variable.
env:
DAY_OF_WEEK: Monday
jobs:
greeting_job:
runs-on: ubuntu-latest
env:
Greeting: Hello
steps:
- name: "Say Hello Mona it's Monday"
if: ${{ env.DAY_OF_WEEK == 'Monday' }}
run: echo "$Greeting $First_Name. Today is $DAY_OF_WEEK!"
env:
First_Name: Mona
In this modification of the first example, we've introduced an if
conditional. The workflow step is now only run if DAYS_OF_WEEK
is set to "Monday". We access this value from the if
conditional statement by using the env
context.
Note: Contexts are usually denoted using the dollar sign and curly braces, as ${{ context.property }}
. In an if
conditional, the ${{
and }}
are optional, but if you use them they must enclose the entire comparison statement, as shown above.
You will commonly use either the env
or github
context to access environment variable values in parts of the workflow that are processed before jobs are sent to runners.
上下文 | Use case | 示例 |
---|---|---|
env | Reference custom environment variables defined in the workflow. | ${{ env.MY_VARIABLE }} |
github | Reference information about the workflow run and the event that triggered the run. | ${{ github.repository }} |
There are many other contexts that you can use for a variety of purposes in your workflows. 更多信息请参阅“上下文”。 For details of where you can use specific contexts within a workflow, see "Context availability."
Other types of variables
In most places in a workflow, the only types of variables that you can use are either environment variables, such as $MY_VARIABLE
, or the equivalent context property, such as ${{ env.MY_VARIABLE }}
. Exceptions are:
- Inputs for the
workflow_call
andworkflow_dispatch
events, which allow you to pass values to a workflow. For more information, seeon.workflow_call.inputs
andon.workflow_dispatch.inputs
. - Job outputs, which allow you to pass values between jobs in a workflow. For more information, see
jobs.<job_id>.outputs
. - The variables in a format expression, which allow you to replace parts of a string. For more information, see
format
.
环境变量命名约定
When you set a custom environment variable, you cannot use any of the default environment variable names. For a complete list of these, see "Default environment variables" below. 如果尝试重写其中一个默认环境变量的值,则会忽略赋值。
您设置的指向文件系统上某个位置的任何新环境变量都应该有 _PATH
后缀。 The HOME
, GITHUB_ENV
, and GITHUB_WORKSPACE
default environment variables are exceptions to this convention.
默认环境变量
The default environment variables that GitHub sets are available to every step in a workflow.
强烈建议操作使用环境变量访问文件系统,而非使用硬编� �的文件路径。 GitHub 设置供操作用于所有运行器环境中的环境变量。
环境变量 | 描述 |
---|---|
CI | 始终设置为 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 . 同� �,actions/checkout 第二次调用时将变成 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 access files located in the same repository as the action. 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 | 当 GitHub Actions 运行工作流程时,始终设置为 true 。 您可以使用此变量来区分测试是在本地运行还是通过 GitHub Actions 运行。 |
GITHUB_ACTOR | 发起工作流程的个人或应用程序的名称。 例如 octocat 。 |
GITHUB_API_URL | 返回 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 environment variables from workflow commands. 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 . 更多信息请参阅“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. 例如 /github/workflow/event.json 。 |
GITHUB_GRAPHQL_URL | 返回 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 | 当前作业的 job_id。 For example, greeting_job . |
GITHUB_PATH | The path on the runner to the file that sets system PATH variables from workflow commands. 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 . 更多信息请参阅“GitHub Actions 的工作流程命令”。 |
GITHUB_REF | 触发工作流程的分支或� �记参考。 For branches this is the format refs/heads/<branch_name> , for tags it is refs/tags/<tag_name> , and for pull requests it is refs/pull/<pr_number>/merge . This variable is only set if a branch or tag is available for the event type. 例如 refs/heads/feature-branch-1 。 |
GITHUB_REPOSITORY | The owner and repository name. 例如 octocat/Hello-World 。 |
RUNNER_NAME | The name of the runner executing the job. For example, Hosted Agent |
RUNNER_TOOL_CACHE | 包含 GitHub 托管运行器预安装工具的目录路径。 For more information, see "About 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 environment variables:
$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID
- Most of the default environment variables have a corresponding, and similarly named, context property. For example, the value of the
GITHUB_REF
environment variable can be read during workflow processing using the${{ github.ref }}
context property.
Detecting the operating system
You can write a single workflow file that can be used for different operating systems by using the RUNNER_OS
default environment variable and the corresponding context property ${{ runner.os }}
. For example, the following workflow could be run successfully if you changed the operating system from macos-latest
to windows-latest
without having to alter the syntax of the environment variables, which differs depending on the shell being used by the runner.
jobs:
if-Windows-else:
runs-on: macos-latest
steps:
- name: condition 1
if: runner.os == 'Windows'
run: echo "The operating system on the runner is $env:RUNNER_OS."
- name: condition 2
if: runner.os != 'Windows'
run: echo "The operating system on the runner is not Windows, it's $RUNNER_OS."
In this example, the two if
statements check the os
property of the runner
context to determine the operating system of the runner. if
conditionals are processed by GitHub Actions, and only steps where the check resolves as true
are sent to the runner. Here one of the checks will always be true
and the other false
, so only one of these steps is sent to the runner. Once the job is sent to the runner, the step is executed and the environment variable in the echo
command is interpolated using the appropriate syntax ($env:NAME
for PowerShell on Windows, and $NAME
for bash and sh on Linux and MacOS). In this example, the statement runs-on: macos-latest
means that the second step will be run.
Passing values between steps and jobs in a workflow
If you generate a value in one step of a job, you can use the value in subsequent steps of the same job by assigning the value to an existing or new environment variable and then writing this to the GITHUB_ENV
environment file. The environment file can be used directly by an action, or from a shell command in the workflow file by using the run
keyword. 更多信息请参阅“GitHub Actions 的工作流程命令”。
If you want to pass a value from a step in one job in a workflow to a step in another job in the workflow, you can define the value as a job output. You can then reference this job output from a step in another job. 更多信息请参阅“GitHub Actions 的工作流程语法”。