Files
docs/i18n/zh-tw/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.7 KiB

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 }} 這樣的表達式來使用它們。

優先級

如果同名變量存在於多個級別,則級別最低的變量優先。 儲存庫級別的變量總是比組織或者使用者級別的變量優先被選中。