变量
当前中文文档翻译不是最新版,访问英文版本查看最新内容,或帮助我们翻译
以下环境变量会在每次工作流运行时自动设置,可以直接访问(例如在 shell 脚本中使用 $CI)。
同时列出 GITEA_* 和 GITHUB_* 名称的变量值相同。
| 名称 | 描述 | 示例 |
|---|---|---|
ACT |
始终为 true,除非 Runner 配置了 runner.set_act_env: false。 |
true |
CI |
始终为 true。 |
true |
GITEA_ACTIONGITHUB_ACTION |
当前步骤的 id,未设置时为步骤的序号。 |
0 |
GITEA_ACTION_PATHGITHUB_ACTION_PATH |
Action 所在的路径。仅在复合 Action 中设置。 | /var/run/act/actions/*** |
GITEA_ACTION_REFGITHUB_ACTION_REF |
正在执行的 Action 的 ref。 | v4 |
GITEA_ACTION_REPOSITORYGITHUB_ACTION_REPOSITORY |
Action 的所有者和仓库名称。 | actions/checkout |
GITEA_ACTIONSGITHUB_ACTIONS |
始终为 true。GITEA_ACTIONS 可用于区分 Gitea Actions 和其他 CI 系统。 |
true |
GITEA_ACTIONS_RUNNER_VERSION |
执行工作流的 Runner 的版本。 | v5.2.4 |
GITEA_ACTORGITHUB_ACTOR |
触发工作流的用户的用户名。 | alice |
GITEA_ACTOR_IDGITHUB_ACTOR_ID |
触发工作流的用户的 ID。 | 1 |
GITEA_API_URLGITHUB_API_URL |
REST API 的 URL。 | https://gitea.example.com/api/v1 |
GITEA_BASE_REFGITHUB_BASE_REF |
拉取请求的目标分支。 | main |
GITEA_DOCKER_WORKSPACE |
Docker 守护进程所见的工作区路径,用于绑定挂载到 Job 启动的容器中,例如在 compose 文件中使用 ${GITEA_DOCKER_WORKSPACE:-.}/data:/app/data。仅在 Job 运行于容器中时设置。 |
/var/lib/docker/volumes/GITEA-ACTIONS-TASK-42-***/_data |
GITEA_ENVGITHUB_ENV |
为后续步骤设置环境变量的文件路径。 | /var/run/act/workflow/envs.txt |
GITEA_EVENT_NAMEGITHUB_EVENT_NAME |
触发工作流的事件名称。 | push |
GITEA_EVENT_PATHGITHUB_EVENT_PATH |
包含事件 Webhook 负载的文件路径。 | /var/run/act/workflow/event.json |
GITEA_GRAPHQL_URLGITHUB_GRAPHQL_URL |
在 Gitea 中为空(不支持 GraphQL)。 | (空) |
GITEA_HEAD_REFGITHUB_HEAD_REF |
拉取请求的源分支。 | feature-branch |
GITEA_JOBGITHUB_JOB |
当前 Job 的 job_id。 |
build |
GITEA_OUTPUTGITHUB_OUTPUT |
设置步骤输出参数的文件路径。 | /var/run/act/workflow/outputcmd.txt |
GITEA_PATHGITHUB_PATH |
为后续步骤添加系统 PATH 条目的文件路径。 |
/var/run/act/workflow/pathcmd.txt |
GITEA_REFGITHUB_REF |
触发工作流的完整 ref。 | refs/heads/main |
GITEA_REF_NAMEGITHUB_REF_NAME |
ref 的短名称。 | main |
GITEA_REF_PROTECTEDGITHUB_REF_PROTECTED |
如果触发工作流的 ref 配置了分支保护,则为 true。 |
true |
GITEA_REF_TYPEGITHUB_REF_TYPE |
ref 的类型:branch 或 tag。 |
branch |
GITEA_REPOSITORYGITHUB_REPOSITORY |
所有者和仓库名称。 | owner/repo |
GITEA_REPOSITORY_IDGITHUB_REPOSITORY_ID |
仓库的 ID。 | 123 |
GITEA_REPOSITORY_OWNERGITHUB_REPOSITORY_OWNER |
仓库所有者的用户名。 | owner |
GITEA_REPOSITORY_OWNER_IDGITHUB_REPOSITORY_OWNER_ID |
仓库所有者的 ID。 | 45 |
GITEA_RETENTION_DAYSGITHUB_RETENTION_DAYS |
Artifact 的保留天数,永久保留时为空。 | 90 |
GITEA_RUN_ATTEMPTGITHUB_RUN_ATTEMPT |
工作流运行的尝试次数。 | 1 |
GITEA_RUN_IDGITHUB_RUN_ID |
每次工作流运行的唯一编号。 | 1234 |
GITEA_RUN_NUMBERGITHUB_RUN_NUMBER |
特定工作流每次运行的唯一编号。 | 42 |
GITEA_SERVER_URLGITHUB_SERVER_URL |
Gitea 实例的 URL。 | https://gitea.example.com |
GITEA_SHAGITHUB_SHA |
触发工作流的提交 SHA。 | a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 |
GITEA_STATEGITHUB_STATE |
设置步骤状态变量的文件路径。 | /var/run/act/workflow/statecmd.txt |
GITEA_STEP_SUMMARYGITHUB_STEP_SUMMARY |
写入 Job 摘要的文件路径。 | /var/run/act/workflow/step-summary-0.md |
GITEA_TRIGGERING_ACTORGITHUB_TRIGGERING_ACTOR |
发起工作流运行的用户的用户名。重新运行时可能与 GITEA_ACTOR 不同。 |
alice |
GITEA_WORKFLOWGITHUB_WORKFLOW |
工作流的名称。 | CI |
GITEA_WORKFLOW_SHAGITHUB_WORKFLOW_SHA |
工作流文件的提交 SHA。 | a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 |
GITEA_WORKSPACEGITHUB_WORKSPACE |
Runner 上的默认工作目录。 | /workspace/owner/repo |
TRACEPARENT |
Job span 的 W3C 追踪上下文,供已接入追踪的工具将 span 添加到 Job 的追踪中。仅在 Runner 导出追踪数据时设置,参见监控。 | 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 |
TRACESTATE |
随 TRACEPARENT 附带的厂商特定追踪数据。仅在追踪包含此类数据时设置。 |
rojo=00f067aa0ba902b7 |
Runner 环境变量
Section titled “Runner 环境变量”| 名称 | 描述 | 示例 |
|---|---|---|
ImageOS |
Job 镜像的操作系统和版本,供 setup-* Action 读取。 |
ubuntu24 |
RUNNER_ARCH |
Runner 的架构。 | X64 |
RUNNER_DEBUG |
当 ACTIONS_STEP_DEBUG 密钥为 true 时设置为 1,否则不设置。 |
1 |
RUNNER_ENVIRONMENT |
始终为 self-hosted。 |
self-hosted |
RUNNER_NAME |
执行 Job 的 Runner 的名称。 | my-runner |
RUNNER_OS |
Runner 的操作系统。 | Linux |
RUNNER_TEMP |
Runner 上临时目录的路径。 | /tmp |
RUNNER_TOOL_CACHE |
Runner 上工具缓存目录的路径。 | /opt/hostedtoolcache |
RUNNER_WORKSPACE |
GITEA_WORKSPACE 的父目录。 |
/workspace/owner |
内部环境变量
Section titled “内部环境变量”这些变量供 Runner 和 Action 内部使用,工作流中通常不需要直接使用。
| 名称 | 描述 | 示例 |
|---|---|---|
ACTIONS_CACHE_URL |
Actions 缓存服务的 URL。 | http://192.168.1.10:8088/ |
ACTIONS_ID_TOKEN_REQUEST_TOKEN |
用于 OIDC 请求的令牌。仅在授予 id-token: write 时设置。 |
*** |
ACTIONS_ID_TOKEN_REQUEST_URL |
请求 OIDC 令牌的 URL。仅在授予 id-token: write 时设置。 |
https://gitea.example.com/api/actions/oidc/token? |
ACTIONS_RESULTS_URL |
存储 Artifact 的 URL。 | https://gitea.example.com |
ACTIONS_RUNTIME_TOKEN |
Actions 流水线 API 的认证令牌。 | *** |
ACTIONS_RUNTIME_URL |
Gitea Actions 流水线 API 的 URL。 | https://gitea.example.com/api/actions_pipeline/ |
用户定义的变量
Section titled “用户定义的变量”您可以创建用户、组织和仓库级别的变量。变量的级别取决于创建它的位置。当创建变量时,变量的名称会被 转换为大写,在yaml文件中引用时需要使用大写。
以下规则适用于变量名:
- 变量名称只能包含字母数字字符 (
[a-z],[A-Z],[0-9]) 或下划线 (_)。不允许使用空格。 - 变量名称不能以
GITHUB_和GITEA_前缀开头。 - 变量名称不能以数字开头。
- 变量名称不区分大小写。
- 变量名称在创建它们的级别上必须是唯一的。
- 变量名称不能为
CI。
创建配置变量后,它们将自动填充到 vars 上下文中。您可以在工作流中使用类似 ${{ vars.VARIABLE_NAME }} 这样的表达式来使用它们。
如果同名变量存在于多个级别,则级别最低的变量优先。 仓库级别的变量总是比组织或者用户级别的变量优先被选中。