nprasad2077/docs
1
1 Fork 0
mirror of https://gitea.com/gitea/docs.git synced 2026-11-07 18:40:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
6135d1dabfdb37796afb9e9f54a655752a6b81aa
docs/i18n/zh-cn/docs/current/usage/actions/variables.md
T
silverwind 8197192134 Document GITEA_* env aliases, missing variables and accurate examples (#618) 
https://gitea.com/gitea/runner/pulls/1358 mirrors every built-in `GITHUB_*` variable as `GITEA_*`. The variables page now lists both names for each, in the same paired style as the context table.

It also adds variables that runners already set but the page left out (`*_ACTOR_ID`, `*_REF_PROTECTED`, `*_REPOSITORY_ID`, `*_REPOSITORY_OWNER_ID`, `*_TRIGGERING_ACTOR`, `*_WORKFLOW_SHA`, `ACT`, `ImageOS`, `RUNNER_DEBUG`, `RUNNER_ENVIRONMENT`, `RUNNER_NAME`, `RUNNER_WORKSPACE`, `TRACEPARENT`, `TRACESTATE`).

Examples copied from GitHub's runner (`/home/runner/work/_temp/...` paths, `__run`, `ghs_***`) are replaced with the values gitea-runner and Gitea actually produce, using placeholder users, repositories and instance URLs.

The zh-cn and zh-tw pages get the environment variable section they never had.

Reviewed-on: https://gitea.com/gitea/docs/pulls/618
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: silverwind <[email protected]>
2026-10-31 05:25:00 +00:00

7.6 KiB
Raw Blame History

date, slug, sidebar_position
date slug sidebar_position
2024-04-10T22:21:00+08:00 actions-variables 25

变量

环境变量

以下环境变量会在每次工作流运行时自动设置，可以直接访问（例如在 shell 脚本中使用 $CI）。 同时列出 GITEA_* 和 GITHUB_* 名称的变量值相同。

名称 描述 示例
ACT 始终为 true，除非 Runner 配置了 runner.set_act_env: false。 true
CI 始终为 true。 true
GITEA_ACTION
GITHUB_ACTION		 当前步骤的 id，未设置时为步骤的序号。 0
GITEA_ACTION_PATH
GITHUB_ACTION_PATH		 Action 所在的路径。仅在复合 Action 中设置。 /var/run/act/actions/***
GITEA_ACTION_REF
GITHUB_ACTION_REF		 正在执行的 Action 的 ref。 v4
GITEA_ACTION_REPOSITORY
GITHUB_ACTION_REPOSITORY		 Action 的所有者和仓库名称。 actions/checkout
GITEA_ACTIONS
GITHUB_ACTIONS		 始终为 true。GITEA_ACTIONS 可用于区分 Gitea Actions 和其他 CI 系统。 true
GITEA_ACTIONS_RUNNER_VERSION 执行工作流的 Runner 的版本。 v5.2.4
GITEA_ACTOR
GITHUB_ACTOR		 触发工作流的用户的用户名。 alice
GITEA_ACTOR_ID
GITHUB_ACTOR_ID		 触发工作流的用户的 ID。 1
GITEA_API_URL
GITHUB_API_URL		 REST API 的 URL。 https://gitea.example.com/api/v1
GITEA_BASE_REF
GITHUB_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_ENV
GITHUB_ENV		 为后续步骤设置环境变量的文件路径。 /var/run/act/workflow/envs.txt
GITEA_EVENT_NAME
GITHUB_EVENT_NAME		 触发工作流的事件名称。 push
GITEA_EVENT_PATH
GITHUB_EVENT_PATH		 包含事件 Webhook 负载的文件路径。 /var/run/act/workflow/event.json
GITEA_GRAPHQL_URL
GITHUB_GRAPHQL_URL		 在 Gitea 中为空（不支持 GraphQL）。 （空）
GITEA_HEAD_REF
GITHUB_HEAD_REF		 拉取请求的源分支。 feature-branch
GITEA_JOB
GITHUB_JOB		 当前 Job 的 job_id。 build
GITEA_OUTPUT
GITHUB_OUTPUT		 设置步骤输出参数的文件路径。 /var/run/act/workflow/outputcmd.txt
GITEA_PATH
GITHUB_PATH		 为后续步骤添加系统 PATH 条目的文件路径。 /var/run/act/workflow/pathcmd.txt
GITEA_REF
GITHUB_REF		 触发工作流的完整 ref。 refs/heads/main
GITEA_REF_NAME
GITHUB_REF_NAME		 ref 的短名称。 main
GITEA_REF_PROTECTED
GITHUB_REF_PROTECTED		 如果触发工作流的 ref 配置了分支保护，则为 true。 true
GITEA_REF_TYPE
GITHUB_REF_TYPE		 ref 的类型：branch 或 tag。 branch
GITEA_REPOSITORY
GITHUB_REPOSITORY		 所有者和仓库名称。 owner/repo
GITEA_REPOSITORY_ID
GITHUB_REPOSITORY_ID		 仓库的 ID。 123
GITEA_REPOSITORY_OWNER
GITHUB_REPOSITORY_OWNER		 仓库所有者的用户名。 owner
GITEA_REPOSITORY_OWNER_ID
GITHUB_REPOSITORY_OWNER_ID		 仓库所有者的 ID。 45
GITEA_RETENTION_DAYS
GITHUB_RETENTION_DAYS		 Artifact 的保留天数，永久保留时为空。 90
GITEA_RUN_ATTEMPT
GITHUB_RUN_ATTEMPT		 工作流运行的尝试次数。 1
GITEA_RUN_ID
GITHUB_RUN_ID		 每次工作流运行的唯一编号。 1234
GITEA_RUN_NUMBER
GITHUB_RUN_NUMBER		 特定工作流每次运行的唯一编号。 42
GITEA_SERVER_URL
GITHUB_SERVER_URL		 Gitea 实例的 URL。 https://gitea.example.com
GITEA_SHA
GITHUB_SHA		 触发工作流的提交 SHA。 a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2
GITEA_STATE
GITHUB_STATE		 设置步骤状态变量的文件路径。 /var/run/act/workflow/statecmd.txt
GITEA_STEP_SUMMARY
GITHUB_STEP_SUMMARY		 写入 Job 摘要的文件路径。 /var/run/act/workflow/step-summary-0.md
GITEA_TRIGGERING_ACTOR
GITHUB_TRIGGERING_ACTOR		 发起工作流运行的用户的用户名。重新运行时可能与 GITEA_ACTOR 不同。 alice
GITEA_WORKFLOW
GITHUB_WORKFLOW		 工作流的名称。 CI
GITEA_WORKFLOW_SHA
GITHUB_WORKFLOW_SHA		 工作流文件的提交 SHA。 a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2
GITEA_WORKSPACE
GITHUB_WORKSPACE		 Runner 上的默认工作目录。 /workspace/owner/repo
TRACEPARENT Job span 的 W3C 追踪上下文，供已接入追踪的工具将 span 添加到 Job 的追踪中。仅在 Runner 导出追踪数据时设置，参见监控。 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01
TRACESTATE 随 TRACEPARENT 附带的厂商特定追踪数据。仅在追踪包含此类数据时设置。 rojo=00f067aa0ba902b7

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

内部环境变量

这些变量供 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/

用户定义的变量

您可以创建用户、组织和仓库级别的变量。变量的级别取决于创建它的位置。当创建变量时，变量的名称会被 转换为大写，在yaml文件中引用时需要使用大写。

命名规则

以下规则适用于变量名：

  • 变量名称只能包含字母数字字符 ([a-z], [A-Z], [0-9]) 或下划线 (_)。不允许使用空格。
  • 变量名称不能以 GITHUB_ 和 GITEA_ 前缀开头。
  • 变量名称不能以数字开头。
  • 变量名称不区分大小写。
  • 变量名称在创建它们的级别上必须是唯一的。
  • 变量名称不能为 CI。

使用

创建配置变量后，它们将自动填充到 vars 上下文中。您可以在工作流中使用类似 ${{ vars.VARIABLE_NAME }} 这样的表达式来使用它们。

优先级

如果同名变量存在于多个级别，则级别最低的变量优先。 仓库级别的变量总是比组织或者用户级别的变量优先被选中。

Reference in new issue View Git Blame Copy Permalink