我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

使用环境变量

GitHub 为每个 GitHub 操作 工作流程运行设置默认环境变量。 您也可以在工作流程文件中设置自定义环境变量。

GitHub 操作 可用于 GitHub Free、GitHub Pro、组织的 GitHub Free、GitHub Team、GitHub Enterprise Cloud 和 GitHub One。 GitHub 操作 不适用于使用旧版按仓库计划的帐户所拥有的私有仓库。 更多信息请参阅“GitHub 的产品”。

本文内容

关于环境变量

GitHub 设置适用于工作流程运行中每个步骤的默认环境变量。 环境变量区分大小写。 在操作或步骤中运行的命令可以创建、读取和修改环境变量。

要设置自定义环境变量,您需要在工作流程文件中指定变量。 您可以使用 jobs.<job_id>.steps.envjobs.<job_id>.envenv 关键字定义步骤、作业或整个工作流程的环境变量。 更多信息请参阅“GitHub 的工作流程语法”。

steps:
  - name: Hello world
    run: echo Hello world $FIRST_NAME $middle_name $Last_Name!
    env:
      FIRST_NAME: Mona
      middle_name: The
      Last_Name: Octocat

您也可以使用 set-env 工作流程命令来设置工作流程中以下步骤可以使用的环境变量。 set-env 命令可直接供操作使用,或使用 run 关键字作为工作流程文件中的 shell 命令。 更多信息请参阅“GitHub 操作 的工作流程命令”。

默认环境变量

强烈建议操作使用环境变量访问文件系统,而非使用硬编码的文件路径。 GitHub 设置供操作用于所有运行器环境中的环境变量。

环境变量描述
CI始终设置为 true
HOME用于存储用户数据的 GitHub 主目录路径。 例如 /github/home
GITHUB_WORKFLOW工作流程的名称。
GITHUB_RUN_ID仓库中每个运行的唯一编号。 如果您重新执行工作流程运行,此编号不变。
GITHUB_RUN_NUMBER仓库中特定工作流程每个运行的唯一编号。 此编号从 1(对应于工作流程的第一个运行)开始,然后随着每个新的运行而递增。 如果您重新执行工作流程运行,此编号不变。
GITHUB_ACTION操作唯一的标识符 (id)。
GITHUB_ACTIONS当 GitHub 操作 运行工作流程时,始终设置为 true。 您可以使用此变量来区分测试是在本地运行还是通过 GitHub 操作 运行。
GITHUB_ACTOR发起工作流程的个人或应用程序的名称。 例如 octocat
GITHUB_REPOSITORY所有者和仓库名称。 例如 octocat/Hello-World
GITHUB_EVENT_NAME触发工作流程的 web 挂钩事件的名称。
GITHUB_EVENT_PATH具有完整 web 挂钩事件有效负载的文件路径。 例如 /github/workflow/event.json
GITHUB_WORKSPACEGitHub 工作空间目录路径。 如果您的工作流程使用 actions/checkout 操作,工作空间目录将包含存储仓库副本的子目录。 如果不使用 actions/checkout 操作,该目录将为空。 例如 /home/runner/work/my-repo-name/my-repo-name
GITHUB_SHA触发工作流程的提交 SHA。 例如 ffac537e6cbbf934b08745a378932722df287a53
GITHUB_REF触发工作流程的分支或标记参考。 例如 refs/heads/feature-branch-1。 如果分支或标记都不适用于事件类型,则变量不会存在。
GITHUB_HEAD_REF仅为复刻的仓库设置。 头部仓库的分支。
GITHUB_BASE_REF仅为复刻的仓库设置。 基础仓库的分支。
GITHUB_SERVER_URL返回 GitHub 服务器的 URL。 例如:https://github.com
GITHUB_API_URL返回 API URL。 例如:https://api.github.com
GITHUB_GRAPHQL_URL返回 GraphQL API URL。 例如:https://api.github.com/graphql

环境变量命名约定

注: GitHub 会保留 GITHUB_ 环境变量前缀供 GitHub 内部使用。 设置有 GITHUB_ 前缀的环境变量或密码将导致错误。

您设置的指向文件系统上某个位置的任何新环境变量都应该有 _PATH 后缀。 HOMEGITHUB_WORKSPACE 默认变量例外于此约定,因为 "home" 和 "workspace" 一词已经暗示位置。

问问别人

找不到要找的内容?

联系我们