Predefined environment variables reference · Gitlab 中文文檔

# Predefined environment variables reference > 原文：[https://docs.gitlab.com/ee/ci/variables/predefined_variables.html](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html) # Predefined environment variables reference[](#predefined-environment-variables-reference "Permalink") 有關此主題的介紹，請通讀[環境變量入門](README.html)文檔. 僅當使用最低版本的[GitLab Runner 時，](https://docs.gitlab.com/runner/)某些預定義的環境變量才可用. 請查閱下表以查找所需的 Runner 版本. **注意：**從 GitLab 9.0 開始，我們已棄用了一些變量. 閱讀[9.0 重命名](deprecated_variables.html#gitlab-90-renamed-variables)部分以查找其替換內容. **強烈建議您使用新變量，因為我們將在以后的 GitLab 版本中刪除舊變量.** 您可以在`.gitlab-ci.yml`文件中添加命令，以[輸出可用于作業的所有變量的值](README.html#list-all-environment-variables) . Kubernetes 特定于環境的環境變量在[Kubernetes 部署變量](../../user/project/clusters/index.html#deployment-variables)部分中進行了詳細介紹. | Variable | GitLab | Runner | Description | | --- | --- | --- | --- | | `CHAT_CHANNEL` | 10.6 | all | 觸發[ChatOps](../chatops/README.html)命令的源聊天通道 | | `CHAT_INPUT` | 10.6 | all | 在[ChatOps](../chatops/README.html)命令中傳遞的其他參數 | | `CI` | all | 0.4 | 標記作業在 CI 環境中執行 | | `CI_API_V4_URL` | 11.7 | all | GitLab API v4 根 URL | | `CI_BUILDS_DIR` | all | 11.10 | 執行構建的頂級目錄. | | `CI_COMMIT_BEFORE_SHA` | 11.2 | all | 先前的最新提交存在于分支中. 合并請求的管道中始終為`0000000000000000000000000000000000000000` | | `CI_COMMIT_DESCRIPTION` | 10.8 | all | 提交的描述：如果標題少于 100 個字符，則不帶第一行的消息；在其他情況下為完整消息. | | `CI_COMMIT_MESSAGE` | 10.8 | all | 完整的提交消息. | | `CI_COMMIT_REF_NAME` | 9.0 | all | 構建項目的分支或標記名稱 | | `CI_COMMIT_REF_PROTECTED` | 11.11 | all | 如果作業在受保護的引用上運行，則為`true`否則為`false` | | `CI_COMMIT_REF_SLUG` | 9.0 | all | `$CI_COMMIT_REF_NAME`小寫，縮短為 63 個字節，并且將`0-9`和`az`以外的所有內容替換為`-` . 沒有前導/尾隨`-` . 在 URL，主機名和域名中使用. | | `CI_COMMIT_SHA` | 9.0 | all | 為其構建項目的提交修訂 | | `CI_COMMIT_SHORT_SHA` | 11.7 | all | `CI_COMMIT_SHA`的前八個字符 | | `CI_COMMIT_BRANCH` | 12.6 | 0.5 | 提交分支名稱. 僅在建立分支時顯示. | | `CI_COMMIT_TAG` | 9.0 | 0.5 | 提交標記名稱. 僅在構建標簽時顯示. | | `CI_COMMIT_TITLE` | 10.8 | all | 提交的標題-消息的第一行 | | `CI_CONCURRENT_ID` | all | 11.10 | 單個執行程序中生成執行的唯一 ID. | | `CI_CONCURRENT_PROJECT_ID` | all | 11.10 | 單個執行程序和項目中生成執行的唯一 ID. | | `CI_CONFIG_PATH` | 9.4 | 0.5 | CI 配置文件的路徑. 默認為`.gitlab-ci.yml` | | `CI_DEBUG_TRACE` | all | 1.7 | 是否啟用[調試日志記錄（跟蹤）](README.html#debug-logging) | | `CI_DEFAULT_BRANCH` | 12.4 | all | 項目的默認分支的名稱. | | `CI_DEPLOY_PASSWORD` | 10.8 | all | [GitLab Deploy 令牌的](../../user/project/deploy_tokens/index.html#gitlab-deploy-token)身份驗證密碼，僅在項目具有相關性時才提供. | | `CI_DEPLOY_USER` | 10.8 | all | [GitLab Deploy 令牌的](../../user/project/deploy_tokens/index.html#gitlab-deploy-token)身份驗證用戶名，僅在項目具有相關性時才存在. | | `CI_DISPOSABLE_ENVIRONMENT` | all | 10.1 | 標記作業是在一次性環境中執行的（僅為該作業創建并在執行后處置/銷毀的東西-除`shell`和`ssh`以外的所有執行程序）. 如果環境是一次性的，則將其設置為 true，否則將完全未定義. | | `CI_ENVIRONMENT_NAME` | 8.15 | all | 該作業的環境名稱. 僅在設置了[`environment:name`](../yaml/README.html#environmentname)存在. | | `CI_ENVIRONMENT_SLUG` | 8.15 | all | 環境名稱的簡化版本，適合包含在 DNS，URL，Kubernetes 標簽等中.僅在設置了[`environment:name`](../yaml/README.html#environmentname)存在. | | `CI_ENVIRONMENT_URL` | 9.3 | all | 該作業的環境的 URL. 僅當設置了[`environment:url`](../yaml/README.html#environmenturl)時才存在. | | `CI_EXTERNAL_PULL_REQUEST_IID` | 12.3 | all | 如果[管道用于外部請求，](../ci_cd_for_external_repos/index.html#pipelines-for-external-pull-requests)則來自 GitHub 的請求請求 ID. 僅在以下情況`only: [external_pull_requests]`可用`only: [external_pull_requests]`或[`rules`](../yaml/README.html#rules)語法，并且拉取請求處于打開狀態. | | `CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_NAME` | 12.3 | all | 如果[管道用于外部](../ci_cd_for_external_repos/index.html#pipelines-for-external-pull-requests)請求，則請求請求的源分支名稱. 僅在以下情況`only: [external_pull_requests]`可用`only: [external_pull_requests]`或[`rules`](../yaml/README.html#rules)語法，并且拉取請求處于打開狀態. | | `CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_SHA` | 12.3 | all | 如果[管道用于外部](../ci_cd_for_external_repos/index.html#pipelines-for-external-pull-requests)請求，則請求請求的源分支的 HEAD SHA. 僅在以下情況`only: [external_pull_requests]`可用`only: [external_pull_requests]`或[`rules`](../yaml/README.html#rules)語法，并且拉取請求處于打開狀態. | | `CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_NAME` | 12.3 | all | 如果[管道用于外部](../ci_cd_for_external_repos/index.html#pipelines-for-external-pull-requests)請求，則請求請求的目標分支名稱. 僅在以下情況`only: [external_pull_requests]`可用`only: [external_pull_requests]`或[`rules`](../yaml/README.html#rules)語法，并且拉取請求處于打開狀態. | | `CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_SHA` | 12.3 | all | 如果[管道用于外部](../ci_cd_for_external_repos/index.html#pipelines-for-external-pull-requests)請求，則請求請求目標分支的 HEAD SHA. 僅在以下情況`only: [external_pull_requests]`可用`only: [external_pull_requests]`或[`rules`](../yaml/README.html#rules)語法，并且拉取請求處于打開狀態. | | `CI_HAS_OPEN_REQUIREMENTS` | 13.1 | all | 僅當管道的項目有任何開放[要求時，](../../user/project/requirements/index.html)才將值包括為`true` . 如果管道項目沒有開放要求，則不包括在內. | | `CI_JOB_ID` | 9.0 | all | GitLab CI / CD 在內部使用的當前作業的唯一 ID | | `CI_JOB_IMAGE` | 12.9 | 12.9 | 運行 CI 作業的圖像的名稱 | | `CI_JOB_MANUAL` | 8.12 | all | 指示作業已手動啟動的標志 | | `CI_JOB_NAME` | 9.0 | 0.5 | `.gitlab-ci.yml`定義的作業名稱 | | `CI_JOB_STAGE` | 9.0 | 0.5 | `.gitlab-ci.yml`定義的階段名稱 | | `CI_JOB_TOKEN` | 9.0 | 1.2 | 用于通過[GitLab 容器注冊表](../../user/packages/container_registry/index.html)進行身份驗證，下載[從屬存儲庫](../../user/project/new_ci_build_permissions_model.html#dependent-repositories)以及訪問[GitLab 管理的 Terraform 狀態的](../../user/infrastructure/index.html#gitlab-managed-terraform-state)令牌. | | `CI_JOB_JWT` | 12.10 | all | RS256 JSON Web 令牌，可用于與支持 JWT 身份驗證的第三方系統進行身份驗證，例如[HashiCorp 的 Vault](../examples/authenticating-with-hashicorp-vault) . | | `CI_JOB_URL` | 11.1 | 0.5 | 職位詳情網址 | | `CI_KUBERNETES_ACTIVE` | 13.0 | all | Included with the value `true` only if the pipeline has a Kubernetes cluster available for deployments. Not included if no cluster is available. Can be used as an alternative to [`only:kubernetes`/`except:kubernetes`](../yaml/README.html#onlykubernetesexceptkubernetes) with [`rules:if`](../yaml/README.html#rulesif) | | `CI_MERGE_REQUEST_ASSIGNEES` | 11.9 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則該合并請求的受讓人的用戶名列表用逗號分隔. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_ID` | 11.6 | all | 合并請求的項目級別 ID. 僅當[管道用于合并請求](../merge_request_pipelines/index.html)并且創建[合并請求](../merge_request_pipelines/index.html)時才可用. | | `CI_MERGE_REQUEST_IID` | 11.6 | all | 合并請求的實例級 IID. 僅[當管道用于合并請求](../merge_request_pipelines/index.html)并且創建[合并請求](../merge_request_pipelines/index.html)時才可用. | | `CI_MERGE_REQUEST_LABELS` | 11.9 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的逗號分隔標簽名稱. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_MILESTONE` | 11.9 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的里程碑標題. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_PROJECT_ID` | 11.6 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的項目的 ID. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_PROJECT_PATH` | 11.6 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的項目路徑（例如， `namespace/awesome-project` ）. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_PROJECT_URL` | 11.6 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的項目的 URL（例如`http://192.168.10.15:3000/namespace/awesome-project` ）. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_REF_PATH` | 11.6 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的 ref 路徑. （例如`refs/merge-requests/1/head` ）. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_SOURCE_BRANCH_NAME` | 11.6 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的源分支名稱. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_SOURCE_BRANCH_SHA` | 11.9 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的源分支的 HEAD SHA. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法，創建合并請求，并且管道是[合并結果管道](../merge_request_pipelines/pipelines_for_merged_results/index.html) . | | `CI_MERGE_REQUEST_SOURCE_PROJECT_ID` | 11.6 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的源項目的 ID. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_SOURCE_PROJECT_PATH` | 11.6 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的源項目的路徑. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_SOURCE_PROJECT_URL` | 11.6 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的源項目的 URL. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_TARGET_BRANCH_NAME` | 11.6 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的目標分支名稱. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_TARGET_BRANCH_SHA` | 11.9 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的目標分支的 HEAD SHA. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法，創建合并請求，并且管道是[合并結果管道](../merge_request_pipelines/pipelines_for_merged_results/index.html) . | | `CI_MERGE_REQUEST_TITLE` | 11.9 | all | 如果[管道用于合并請求](../merge_request_pipelines/index.html) ，則合并請求的標題. 僅在以下情況`only: [merge_requests]`可用：僅使用`only: [merge_requests]`或[`rules`](../yaml/README.html#rules)語法并創建合并請求. | | `CI_MERGE_REQUEST_EVENT_TYPE` | 12.3 | all | 合并請求的事件類型（如果[管道用于合并請求）](../merge_request_pipelines/index.html) . 可以`detached` ， `merged_result`或`merge_train` . | | `CI_NODE_INDEX` | 11.5 | all | 作業在作業集中的索引. 如果作業未并行化，則不會設置此變量. | | `CI_NODE_TOTAL` | 11.5 | all | Total number of instances of this job running in parallel. If the job is not parallelized, this variable is set to `1`. | | `CI_PAGES_DOMAIN` | 11.8 | all | 托管 GitLab 頁面的已配置域. | | `CI_PAGES_URL` | 11.8 | all | GitLab 頁面構建頁面的 URL. 始終屬于`CI_PAGES_DOMAIN`的子域. | | `CI_PIPELINE_ID` | 8.10 | all | GitLab CI / CD 在內部使用的當前管道的唯一 ID | | `CI_PIPELINE_IID` | 11.0 | all | 當前管道的唯一 ID 范圍為項目 | | `CI_PIPELINE_SOURCE` | 10.0 | all | 指示如何觸發管道. 可能的選項是： `push` ， `web` ， `schedule` ， `api` ， `external` ， `chat` ， `webide` ， `merge_request_event` ， `external_pull_request_event` ， `parent_pipeline` ， [`trigger`或`pipeline`](../triggers/README.html#authentication-tokens) （自 13.0 起改名為`cross_project_pipeline` ）. 對于在 GitLab 9.5 之前創建的管道，這將顯示為`unknown` . | | `CI_PIPELINE_TRIGGERED` | all | all | 指示已[觸發](../triggers/README.html)作業的標志 | | `CI_PIPELINE_URL` | 11.1 | 0.5 | 管道詳細資料網址 | | `CI_PROJECT_DIR` | all | all | 克隆存儲庫以及運行作業的完整路徑. 如果設置了 GitLab Runner 的`builds_dir`參數，則相對于`builds_dir`的值設置此變量. 有關更多信息，請參見 GitLab Runner 的[高級配置](https://docs.gitlab.com/runner/configuration/advanced-configuration.html) . | | `CI_PROJECT_ID` | all | all | GitLab CI / CD 在內部使用的當前項目的唯一 ID | | `CI_PROJECT_NAME` | 8.10 | 0.5 | 當前正在構建的項目的目錄名稱. 例如，如果項目 URL 為`gitlab.example.com/group-name/project-1` ，則`CI_PROJECT_NAME`將為`project-1` . | | `CI_PROJECT_NAMESPACE` | 8.10 | 0.5 | 當前正在構建的項目名稱空間（用戶名或組名） | | `CI_PROJECT_ROOT_NAMESPACE` | 13.2 | 0.5 | 當前正在構建的**根**項目名稱空間（用戶名或組名）. 例如，如果`CI_PROJECT_NAME`是`root-group/child-group/grandchild-group` ，則`CI_PROJECT_ROOT_NAMESPACE`將是`root-group` . | | `CI_PROJECT_PATH` | 8.10 | 0.5 | 具有項目名稱的名稱空間 | | `CI_PROJECT_PATH_SLUG` | 9.3 | all | `$CI_PROJECT_PATH`小寫，除`0-9`和`az`以外的所有內容都用`-`代替. 在 URL 和域名中使用. | | `CI_PROJECT_REPOSITORY_LANGUAGES` | 12.3 | all | 庫中使用的語言的逗號分隔，小寫列表（例如`ruby,javascript,html,css` ） | | `CI_PROJECT_TITLE` | 12.4 | all | 可讀的項目名稱，顯示在 GitLab Web 界面中. | | `CI_PROJECT_URL` | 8.10 | 0.5 | The HTTP(S) address to access project | | `CI_PROJECT_VISIBILITY` | 10.3 | all | 項目可見性（內部，私人，公共） | | `CI_REGISTRY` | 8.10 | 0.5 | 如果啟用了 Container Registry，它將返回 GitLab 的 Container Registry 的地址. 如果在注冊表配置中指定了一個變量，則該變量將包含`:port`值. | | `CI_REGISTRY_IMAGE` | 8.10 | 0.5 | 如果為項目啟用了容器注冊表，則它將返回綁定到特定項目的注冊表地址 | | `CI_REGISTRY_PASSWORD` | 9.0 | all | The password to use to push containers to the GitLab Container Registry, for the current project. | | `CI_REGISTRY_USER` | 9.0 | all | 用于將容器推送到當前項目的 GitLab 容器注冊表的用戶名. | | `CI_REPOSITORY_URL` | 9.0 | all | 克隆 Git 存儲庫的 URL | | `CI_RUNNER_DESCRIPTION` | 8.10 | 0.5 | 保存在 GitLab 中的跑步者的描述 | | `CI_RUNNER_EXECUTABLE_ARCH` | all | 10.6 | GitLab Runner 可執行文件的操作系統/體系結構（請注意，它不一定與執行程序的環境相同） | | `CI_RUNNER_ID` | 8.10 | 0.5 | 正在使用的跑步者的唯一 ID | | `CI_RUNNER_REVISION` | all | 10.6 | 正在執行當前作業的 GitLab Runner 版本 | | `CI_RUNNER_SHORT_TOKEN` | all | 12.3 | GitLab Runner 令牌的前八個字符用于驗證新的作業請求. 用作跑步者的唯一 ID | | `CI_RUNNER_TAGS` | 8.10 | 0.5 | 定義的運行器標簽 | | `CI_RUNNER_VERSION` | all | 10.6 | 正在執行當前作業的 GitLab Runner 版本 | | `CI_SERVER` | all | all | 標記作業在 CI 環境中執行 | | `CI_SERVER_URL` | 12.7 | all | GitLab 實例的基本 URL，包括協議和端口（例如`https://gitlab.example.com:8080` ） | | `CI_SERVER_HOST` | 12.1 | all | GitLab 實例 URL 的主機組件，不帶協議和端口（例如`gitlab.example.com` ） | | `CI_SERVER_PORT` | 12.8 | all | GitLab 實例 URL 的端口組件，不包含主機和協議（例如`3000` ） | | `CI_SERVER_PROTOCOL` | 12.8 | all | GitLab 實例 URL 的協議組件，不帶主機和端口（例如`https` ） | | `CI_SERVER_NAME` | all | all | 用于協調作業的 CI 服務器的名稱 | | `CI_SERVER_REVISION` | all | all | 用于計劃作業的 GitLab 修訂版 | | `CI_SERVER_VERSION` | all | all | 用于計劃作業的 GitLab 版本 | | `CI_SERVER_VERSION_MAJOR` | 11.4 | all | GitLab 版本主要組件 | | `CI_SERVER_VERSION_MINOR` | 11.4 | all | GitLab 版本次要組件 | | `CI_SERVER_VERSION_PATCH` | 11.4 | all | GitLab 版本補丁組件 | | `CI_SHARED_ENVIRONMENT` | all | 10.1 | 標記作業是在共享環境中執行的（在諸如`shell`或`ssh`執行程序之類的 CI 調用之間持久存在的內容）. 如果共享環境，則將其設置為 true，否則將完全未定義. | | `GITLAB_CI` | all | all | 標記作業在 GitLab CI / CD 環境中執行 | | `GITLAB_FEATURES` | 10.6 | all | 以逗號分隔的實例和計劃可用的許可功能列表 | | `GITLAB_USER_EMAIL` | 8.12 | all | 開始工作的用戶的電子郵件 | | `GITLAB_USER_ID` | 8.12 | all | 開始工作的用戶的 ID | | `GITLAB_USER_LOGIN` | 10.0 | all | 開始工作的用戶的登錄用戶名 | | `GITLAB_USER_NAME` | 10.0 | all | 開始工作的用戶的真實姓名 |