跳到主要内容

变量

本文档是 AtomGit Action 变量的完整参考，包含 env、vars、secrets、inputs 四种变量类型说明及 ATOMGIT_* 系统变量完整列表。

AtomGit Action 支持多种类型的变量，用于在工作流中传递配置信息和敏感数据。

4.1 变量类型​

env 变量（自定义环境变量）​

在 workflow、job、step 级别通过 env: 关键字定义的环境变量，直接作为系统环境变量注入到 Runner 中。

env:
  GLOBAL_VAR: global_value    # workflow 级别
jobs:
  build:
    name: 构建
    env:
      JOB_VAR: job_value      # job 级别
    steps:
      - name: Step
        env:
          STEP_VAR: step_value  # step 级别
        run: echo "$GLOBAL_VAR $JOB_VAR $STEP_VAR"

在 run: 脚本中可直接作为系统环境变量使用（$VAR_NAME），在表达式中使用 ${{ env.VAR_NAME }}。

vars 变量（配置变量）​

在 AtomGit 平台设置页面定义的非敏感配置变量，按组织/项目级别管理。

  • 组织级别 vars：组织下所有项目可用
  • 项目级别 vars：仅当前项目可用

访问：${{ vars.VAR_NAME }}

secrets 变量（加密密钥）​

在 AtomGit 平台设置页面定义的敏感加密数据，按组织/项目级别管理。

  • 组织级别 secrets：组织下所有项目可用
  • 项目级别 secrets：仅当前项目可用
  • 环境级别 secrets：绑定到特定部署环境

访问：${{ secrets.SECRET_NAME }}

日志脱敏： 所有 secrets 值在日志输出中自动替换为 ***，无法通过日志泄露。

inputs 变量（工作流输入参数）​

在 workflow_dispatch 或 workflow_call 的 inputs: 中定义的参数。

访问：${{ inputs.INPUT_NAME }}

inputs 属性字段：

字段说明示例值
typeinputs类型string , boolean, choice , number
required是否必填true, false
description描述env_type, port_number
default默认值true, false
options单选项，仅适用于 choice类型info, warning, error

AtomGit Action 的 inputs 支持 string , boolean ,choice , number 类型。

type说明示例值
string字符串输入test, prod, dev
boolean布尔值输入true, false
choice单选输入，通过options字段配置选项info, warning, error
number数字输入8080, 50

4.2 变量优先级​

当同名变量在不同级别定义时，优先级从高到低为：

step > job > workflow

即：step 级别 env > job 级别 env > workflow 级别 env。

对于 vars 和 secrets，项目级别 > 组织级别（项目级别同名变量覆盖组织级别）。

4.3 ATOMGIT_* 系统变量完整列表​

AtomGit Runner 在每个工作流运行时自动注入以下系统环境变量：

系统变量说明示例值
ATOMGIT_TOKEN工作流认证令牌（自动生成，用于 API 调用）ghs_xxxxx
ATOMGIT_SHA触发提交的 SHAa1b2c3d4e5f6...
ATOMGIT_REF触发引用全名refs/heads/main
ATOMGIT_REF_NAME触发引用短名main
ATOMGIT_REF_TYPE引用类型branch / tag
ATOMGIT_EVENT_NAME触发事件名称push
ATOMGIT_EVENT_PATH事件 payload JSON 文件路径/home/runner/_temp/_atomgit_workflow/event.json
ATOMGIT_WORKSPACERunner 工作区路径/home/runner/workspace/repo
ATOMGIT_ACTION当前 Action 名称my-action
ATOMGIT_REPOSITORY仓库全名owner/repo
ATOMGIT_RUN_ID工作流运行 ID12345
ATOMGIT_RUN_NUMBER工作流运行编号42
ATOMGIT_RUN_ATTEMPT重试次数1
ATOMGIT_WORKFLOW工作流名称CI Pipeline
ATOMGIT_HEAD_REFPR 源分支（仅 PR 事件）feature/new-api
ATOMGIT_BASE_REFPR 目标分支（仅 PR 事件）main
ATOMGIT_SERVER_URLAtomGit 平台根 URLhttps://atomgit.com
ATOMGIT_API_URLAtomGit API 基础 URLhttps://api.atomgit.com
ATOMGIT_GRAPHQL_URLAtomGit GraphQL API URLhttps://api.atomgit.com/graphql
ATOMGIT_OUTPUT步骤输出文件路径见工作流命令参考
ATOMGIT_ENV步骤环境变量文件路径见工作流命令参考
ATOMGIT_PATH步骤系统 PATH 文件路径见工作流命令参考
ATOMGIT_STEP_SUMMARY步骤摘要文件路径见工作流命令参考
ATOMGIT_ACTION_REPOSITORYAction 来源仓库owner/action-repo
ATOMGIT_ACTION_REFAction 来源引用v1

注意： ATOMGIT_TOKEN 仅在工作流运行期间有效，运行结束后失效。请勿将此令牌持久化存储。