Github Actions 环境变量

10 min read

默认的环境变量

环境变量 描述
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_WORKSPACE GitHub 工作空间目录路径。 如果工作流程使用 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_TOKEN

GITHUB_TOKEN 是 GitHub 自动为工作流创建的 token。当需要权限认证时,可以通过 ${{ secrets.GITHUB_TOKEN}} 在整个工作流中全局使用。比如上面的示例工作流配置,在部署博客时需要向分支推送编译后的静态文件,此时就需要进行校验。