预定义 CI/CD 变量参考

预定义 CI/CD 变量 在每个极狐GitLab CI/CD 流水线中都可用。

要避免覆盖预定义变量，因为这可能导致流水线的行为异常。

变量可用性

预定义变量在流水线执行的三个不同阶段可用：

  • 预流水线：预流水线变量在创建流水线之前可用。这些变量是仅使用 include:rules 来控制在创建流水线时要使用哪些配置文件。
  • 流水线：这些变量在流水线创建时可用。除了预流水线变量外，流水线变量还可以用于配置在作业中定义的 rules ，以确定要添加到流水线中的哪些作业。
  • 仅作业：这些变量仅在 runner 选择作业并运行作业时为每个作业可用，切：
变量 极狐GitLab Runner 描述
CHAT_CHANNEL 13.10 所有 触发 ChatOps 命令的源聊天频道。
CHAT_INPUT 13.10 所有 使用 ChatOps 命令传递的附加参数。
CHAT_USER_ID 14.4 所有 触发 ChatOps 命令的用户的聊天服务用户 ID。
CI 所有 13.10 适用于在 CI/CD 中执行的所有作业。可用时为 true。
CI_API_V4_URL 13.10 所有 极狐GitLab API v4 根 URL。
CI_BUILDS_DIR 所有 13.10 执行构建的顶级目录。
CI_COMMIT_AUTHOR 13.11 所有 Name <email> 格式的提交作者。
CI_COMMIT_BEFORE_SHA 13.10 所有 出现在分支或标签上的上一个最新提交。在合并请求的流水线中总是 0000000000000000000000000000000000000000。
CI_COMMIT_BRANCH 13.10 13.10 提交分支名称。在分支流水线中可用，包括默认分支的流水线。在合并请求流水线或标签流水线中不可用。
CI_COMMIT_DESCRIPTION 13.10 所有 提交的描述。如果标题短于 100 个字符，则消息没有第一行。
CI_COMMIT_MESSAGE 13.10 所有 完整的提交消息。
CI_COMMIT_REF_NAME 13.10 所有 为其构建项目的分支或标签名称。
CI_COMMIT_REF_PROTECTED 13.10 所有 如果作业正在运行以获取受保护的 ref 为 true 。
CI_COMMIT_REF_SLUG 13.10 所有 CI_COMMIT_REF_NAME 小写，缩短为 63 字节，除了 0-9 和 a-z 之外的所有内容都替换为 -。没有前导/尾随-。在 URL、主机名和域名中使用。
CI_COMMIT_SHA 13.10 所有 项目为其构建的提交修订。
CI_COMMIT_SHORT_SHA 13.10 所有 CI_COMMIT_SHA 的前八个字符。
CI_COMMIT_TAG 13.10 13.10 提交标签名称。仅在标签流水线中可用。
CI_COMMIT_TAG_MESSAGE 15.5 所有 提交标签消息。仅在标签流水线中可用。
CI_COMMIT_TIMESTAMP 13.4 所有 ISO 8601 格式的提交时间戳。
CI_COMMIT_TITLE 13.10 所有 提交的标题。消息的完整第一行。
CI_CONCURRENT_ID 所有 13.10 单个 executor 中构建执行的唯一 ID。
CI_CONCURRENT_PROJECT_ID 所有 13.10 单个 executor 和项目中构建执行的唯一 ID。
CI_CONFIG_PATH 13.10 13.10 CI/CD 配置文件的路径。默认为.gitlab-ci.yml。在正在运行的流水线中只读。
CI_DEBUG_TRACE 所有 13.10 如果 debug 日志 (跟踪) 已启用为 true。
CI_DEBUG_SERVICES 15.7 15.7 true 如果启用了服务容器日志，值为 true。
CI_DEFAULT_BRANCH 13.10 所有 项目默认分支的名称。
CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX 13.7 所有 通过 Dependency Proxy 拉取镜像的顶级群组镜像前缀。
CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX 14.3 所有 通过 Dependency Proxy 拉取镜像的直接群组镜像前缀。
CI_DEPENDENCY_PROXY_PASSWORD 13.7 所有 通过 Dependency Proxy 拉取镜像的密码。
CI_DEPENDENCY_PROXY_SERVER 13.7 所有 用于登录 Dependency Proxy 的服务器。相当于 $CI_SERVER_HOST:$CI_SERVER_PORT。
CI_DEPENDENCY_PROXY_USER 13.7 所有 通过 Dependency Proxy 拉取镜像的用户名。
CI_DEPLOY_FREEZE 13.2 所有 仅当流水线在部署冻结窗口期间运行时才可用。可用时为 true 。
CI_DEPLOY_PASSWORD 13.10 所有 极狐GitLab Deploy Token 的认证密码，如果项目有的话。
CI_DEPLOY_USER 13.10 所有 极狐GitLab Deploy Token 的认证用户名，如果项目有的话。
CI_DISPOSABLE_ENVIRONMENT 所有 13.10 仅当作业在一次性环境中执行时才可用（仅为该作业创建并在执行后处理/销毁 - 除 shell 和 ssh 之外的所有 executor）。可用时为 true。
CI_ENVIRONMENT_NAME 13.10 所有 此作业的环境名称。如果设置了 environment:name，则可用。
CI_ENVIRONMENT_SLUG 13.10 所有 环境名称的简化版本，适合包含在 DNS、URL、Kubernetes labels 等。如果设置了 environment:name，则可用。Slug 被截断为 24 个字符。
CI_ENVIRONMENT_URL 13.10 所有 此作业的环境 URL。如果设置了 environment:url，则可用。
CI_ENVIRONMENT_ACTION 13.11 所有 为此作业的环境指定的操作注释。如果设置了 environment:action，则可用。可以是 start、prepare 或 stop。
CI_ENVIRONMENT_TIER 14.0 所有 此作业的环境部署级别。
CI_RELEASE_DESCRIPTION 15.5 所有 发布的描述。仅在标签流水线上可用。描述长度限制为前 1024 个字符。
CI_GITLAB_FIPS_MODE 14.10 所有 实例中是否启用 FIPS 模式的配置设置。
CI_HAS_OPEN_REQUIREMENTS 13.10 所有 仅当流水线的项目具有打开的需求 时才可用。可用时为 true。
CI_JOB_ID 13.10 所有 作业的内部 ID，在极狐GitLab 实例中的所有作业中是唯一的。
CI_JOB_IMAGE 13.10 13.10 运行作业的 Docker 镜像的名称。
CI_JOB_MANUAL 13.10 所有 如果作业是手动启动为 true。
CI_JOB_NAME 13.10 13.10 作业名称
CI_JOB_NAME_SLUG 15.4 所有 CI_JOB_NAME_SLUG 的小写，缩短为 63 字节，除 0-9 和 a-z 以外的所有内容都替换为 -。没有前导/尾随的 -。在路径中使用。
CI_JOB_STAGE 13.10 13.10 作业阶段名称。
CI_JOB_STATUS 所有 13.5 执行每个 runner 阶段时的作业状态。与 after_script 一起使用。可以是 success、failed 或 canceled。
CI_JOB_TIMEOUT 15.7 15.7 作业超时的值。
CI_JOB_TOKEN 13.10 13.10 使用某些 API 端点进行身份验证的令牌。只要作业正在运行，令牌就有效。
CI_JOB_URL 13.10 13.10 作业详细信息 URL。
CI_JOB_STARTED_AT 13.10 所有 作业开始时的 UTC 日期时间，采用 ISO 8601 格式。
CI_KUBERNETES_ACTIVE 13.10 所有 仅当流水线具有可用于部署的 Kubernetes 集群时才可用。可用时为 true。
CI_NODE_INDEX 13.10 所有 作业集中的作业 index。仅当作业使用 parallel 时可用。
CI_NODE_TOTAL 13.10 所有 此作业并行运行的实例总数。如果作业不使用 parallel，则设置为 1。
CI_OPEN_MERGE_REQUESTS 13.10 所有 使用当前分支和项目作为合并请求源的最多四个合并请求的逗号分隔列表。如果分支具有关联的合并请求，则仅在分支和合并请求流水线中可用。例如，gitlab-org/gitlab!333,gitlab-org/gitlab-foss!11。
CI_PAGES_DOMAIN 13.10 所有 托管极狐GitLab Pages 的配置域名。
CI_PAGES_URL 13.10 所有 极狐GitLab Pages 站点的 URL。始终是 CI_PAGES_DOMAIN 的子域名。
CI_PIPELINE_ID 13.10 所有 当前流水线的实例级 ID。该 ID 在实例上的所有项目中都是唯一的。
CI_PIPELINE_IID 13.10 所有 当前流水线的项目级 IID（内部 ID）。此 ID 仅在当前项目中是唯一的。
CI_PIPELINE_SOURCE 13.10 所有 流水线是如何触发的。可以是 push、web、schedule、api、external、chat、webide、merge_request_event、external_pull_request_event、parent_pipeline、trigger 或 pipeline 。
CI_PIPELINE_TRIGGERED 所有 所有 如果作业是触发的为 true。
CI_PIPELINE_URL 13.10 13.10 流水线详细信息的 URL。
CI_PIPELINE_CREATED_AT 13.10 所有 创建流水线时的 UTC 日期时间，采用 ISO 8601 格式。
CI_PIPELINE_NAME 16.3 所有 workflow:name 中定义的名称。
CI_PROJECT_DIR 所有 所有 仓库克隆到的完整路径，以及作业从哪里运行。如果设置了极狐GitLab Runner builds_dir 参数，这个变量是相对于 builds_dir 的值设置的。
CI_PROJECT_ID 所有 所有 当前项目的 ID。该 ID 在实例上的所有项目中都是唯一的。
CI_PROJECT_NAME 13.10 13.10 项目目录的名称。例如，如果项目 URL 是 gitlab.example.com/group-name/project-1，则 CI_PROJECT_NAME 是 project-1。
CI_PROJECT_NAMESPACE 13.10 13.10 作业的项目命名空间（用户名或群组名）。
CI_PROJECT_NAMESPACE_ID 15.7 13.10 作业的项目命名空间 ID。
CI_PROJECT_PATH_SLUG 13.10 所有 $CI_PROJECT_PATH 小写，不是 a-z 或 0-9 的字符替换为 - 并缩短为 63 字节。在 URL 和域名中使用。
CI_PROJECT_PATH 13.10 13.10 包含项目名称的项目命名空间。
CI_PROJECT_REPOSITORY_LANGUAGES 13.10 所有 仓库中使用的语言的逗号分隔的小写列表。例如 ruby,javascript,html,css。
CI_PROJECT_ROOT_NAMESPACE 13.2 13.10 作业的根项目命名空间（用户名或群组名）。例如，如果 CI_PROJECT_NAMESPACE 是 root-group/child-group/grandchild-group，则 CI_PROJECT_ROOT_NAMESPACE 是 root-group。
CI_PROJECT_TITLE 13.10 所有 Web 界面中显示的人类可读的项目名称。
CI_PROJECT_DESCRIPTION 15.1 所有 Web 界面中显示的项目描述。
CI_PROJECT_URL 13.10 13.10 项目的 HTTP(S) 地址。
CI_PROJECT_VISIBILITY 13.10 所有 项目可见性。可以是 internal、private 或 public。
CI_PROJECT_CLASSIFICATION_LABEL 14.2 所有 项目外部授权分类标记。
CI_REGISTRY_IMAGE 13.10 13.10 项目的 Container Registry 的地址。仅当为项目启用了 Container Registry 时才可用。
CI_REGISTRY_PASSWORD 13.10 所有 将容器推送到项目的极狐GitLab Container Registry 的密码。仅当为项目启用了 Container Registry 时才可用。 此密码值与 CI_JOB_TOKEN 相同，并且仅在作业运行时有效。使用 CI_DEPLOY_PASSWORD 长期访问镜像库。
CI_REGISTRY_USER 13.10 所有 将容器推送到项目的极狐GitLab Container Registry 的用户名。仅当为项目启用了 Container Registry 时才可用。
CI_REGISTRY 13.10 13.10 极狐GitLab Container Registry 的地址。仅当为项目启用了 Container Registry 时才可用。 如果在镜像库配置中指定了一个值，则此变量包括一个 :port 值。
CI_REPOSITORY_URL 13.10 所有 克隆 Git 仓库的 URL。
CI_RUNNER_DESCRIPTION 13.10 13.10 runner 的描述。
CI_RUNNER_EXECUTABLE_ARCH 所有 13.10 极狐GitLab Runner 可执行文件的操作系统/架构。可能和 executor 的环境不一样。
CI_RUNNER_ID 13.10 13.10 正在使用的 runner 的唯一 ID。
CI_RUNNER_REVISION 所有 13.10 运行作业的 runner 的修订版。
CI_RUNNER_SHORT_TOKEN 所有 13.10 runner 的唯一 ID，用于验证新的作业请求。在 14.9 及更高版本中，令牌包含前缀，并且使用前 17 个字符。在 14.9 版本之前，使用前八个字符。
CI_RUNNER_TAGS 13.10 13.10 以逗号分隔的 runner 标签列表。
CI_RUNNER_VERSION 所有 13.10 运行作业的极狐GitLab Runner 的版本。
CI_SERVER_FQDN 预流水线 实例的完全限定域名（FQDN）比如。 gitlab.example.com:8080。引入于极狐GitLab 16.10。  
CI_SERVER_HOST 13.10 所有 极狐GitLab 实例 URL 的主机，没有协议或端口。例如 gitlab.example.com。
CI_SERVER_NAME 所有 所有 协调作业的 CI/CD 服务器的名称。
CI_SERVER_PORT 13.10 所有 极狐GitLab 实例 URL 的端口，没有主机或协议。例如 8080。
CI_SERVER_PROTOCOL 13.10 所有 极狐GitLab 实例 URL 的协议，没有主机或端口。例如 https。
CI_SERVER_SHELL_SSH_HOST 15.11 所有 极狐GitLab 实例的 SSH 主机。用于通过 SSH 访问 Git 仓库，例如 gitlab.com。
CI_SERVER_SHELL_SSH_PORT 预流水线 极狐GitLab 实例的 SSH 端口，用于通过 SSH 来访问 Git 仓库。比如， 22。引入于极狐GitLab 15.11。  
CI_SERVER_PROTOCOL 15.11 所有 极狐GitLab 实例的 SSH 端口。用于通过 SSH 访问 Git 仓库，例如 22。
CI_SERVER_REVISION 所有 所有 计划作业的极狐GitLab 修订版。
CI_SERVER_TLS_CA_FILE 所有 所有 包含 TLS CA 证书的文件，用于在 runner 设置中设置 tls-ca-file 时验证极狐GitLab 服务器。
CI_SERVER_TLS_CERT_FILE 所有 所有 包含 TLS 证书的文件，用于在 runner 设置中设置 tls-ca-file 时验证极狐GitLab 服务器。
CI_SERVER_TLS_KEY_FILE 所有 所有 包含 TLS 密钥的文件，用于在 runner 设置中设置 tls-ca-file 时验证极狐GitLab 服务器。
CI_SERVER_URL 13.10 所有 极狐GitLab 实例的基本 URL，包括协议和端口。 例如 https://gitlab.example.com:8080。
CI_SERVER_VERSION_MAJOR 13.10 所有 极狐GitLab 实例的主版本。例如，如果版本为 13.6.1，则 CI_SERVER_VERSION_MAJOR 为 13。
CI_SERVER_VERSION_MINOR 13.10 所有 极狐GitLab 实例的小版本。例如，如果版本为 13.6.1，则 CI_SERVER_VERSION_MINOR 为 6。
CI_SERVER_VERSION_PATCH 13.10 所有 极狐GitLab 实例的补丁版本。例如，如果版本为 13.6.1，则 CI_SERVER_VERSION_PATCH 为 1。
CI_SERVER_VERSION 所有 所有 极狐GitLab 实例的完整版本。
CI_SERVER 所有 所有 适用于在 CI/CD 中执行的所有作业。可用时为 true。
CI_SHARED_ENVIRONMENT 所有 13.10 仅当作业在共享环境中执行时才可用（跨 CI/CD 调用持久化的，如 shell 或 ssh executor）。可用时为 true。
CI_TEMPLATE_REGISTRY_HOST 15.3 所有 CI/CD 模版使用的镜像库的主机。默认为 registry.gitlab.com。
CI_TRIGGER_SHORT_TOKEN 仅作业 当前作业触发器令牌的前四个字符。仅在使用触发器令牌触发流水线时可用。比如，对于令牌 glptt-1234567890abcdefghij， CI_TRIGGER_SHORT_TOKEN 将是 1234。引入于极狐GitLab 17.0。  
GITLAB_CI 所有 所有 适用于在 CI/CD 中执行的所有作业。可用时为 true。
GITLAB_FEATURES 13.10 所有 可用于实例和许可证的许可功能的逗号分隔列表。
GITLAB_USER_EMAIL 13.10 所有 启动流水线的用户的电子邮件，除非作业是手动作业。在手动作业中，该值是启动作业的用户的电子邮件。
GITLAB_USER_ID 13.10 所有 启动流水线的用户的 ID，除非作业是手动作业。在手动作业中，该值是启动作业的用户的 ID。
GITLAB_USER_LOGIN 13.10 所有 启动流水线的用户的用户名，除非作业是手动作业。在手动作业中，该值是启动作业的用户的用户名。
GITLAB_USER_NAME 13.10 所有 启动流水线的用户的姓名，除非作业是手动作业。在手动作业中，该值是启动作业的用户的姓名。
KUBERCONFIG 14.2 所有 Kubeconfig 文件的路径，其中包含每个共享代理连接的上下文。只有当极狐GitLab 代理授权访问项目时才可用。
TRIGGER_PAYLOAD 13.9 所有 Webhook 负载。仅当流水线使用 Webhook 触发时可用。

合并请求流水线的预定义变量

这些变量在极狐GitLab 创建流水线（预流水线）前可用。这些变量可以和 include:rules 一起使用，以控制在创建流水线时使用的配置文件。

流水线必须是合并请求流水线，并且合并请求必须是打开的。

变量 极狐GitLab Runner 描述
CI_MERGE_REQUEST_APPROVED 14.1 所有 合并请求的批准状态。当合并请求批准 可用并且合并请求已被批准时为 true。
CI_MERGE_REQUEST_ASSIGNEES 13.10 所有 合并请求的指派人用户名的逗号分隔列表。
CI_MERGE_REQUEST_DIFF_BASE_SHA 13.7 所有 合并请求差异的基本 SHA。
CI_MERGE_REQUEST_DIFF_ID 13.7 所有 合并请求差异的版本。
CI_MERGE_REQUEST_EVENT_TYPE 13.10 所有 合并请求的事件类型。可以是 detached、merged_result 或 merge_train。
CI_MERGE_REQUEST_DESCRIPTION 合并请求的描述。如果描述超过 2700 个字符，则只有开头的 2700 个字符存储在变量中。引入于极狐GitLab 16.7。    
CI_MERGE_REQUEST_DESCRIPTION_IS_TRUNCATED 如果合并请求的描述过长，导致 CI_MERGE_REQUEST_DESCRIPTION 被截断至 2700 个字符，则为 true。 引入于极狐GitLab 16.8。    
CI_MERGE_REQUEST_ID 13.10 所有 合并请求的实例级 ID。这是极狐GitLab 上所有项目的唯一 ID。
CI_MERGE_REQUEST_IID 13.10 所有 合并请求的项目级 IID（内部 ID）。此 ID 对于当前项目是唯一的。
CI_MERGE_REQUEST_LABELS 13.10 所有 合并请求的逗号分隔标签名称。
CI_MERGE_REQUEST_MILESTONE 13.10 所有 合并请求的里程碑标题。
CI_MERGE_REQUEST_PROJECT_ID 13.10 所有 合并请求的项目 ID。
CI_MERGE_REQUEST_PROJECT_PATH 13.10 所有 合并请求的项目路径。例如 namespace/awesome-project。
CI_MERGE_REQUEST_PROJECT_URL 13.10 所有 合并请求的项目的 URL。例如，http://192.168.10.15:3000/namespace/awesome-project。
CI_MERGE_REQUEST_REF_PATH 13.10 所有 合并请求的引用路径。例如，refs/merge-requests/1/head。
CI_MERGE_REQUEST_SOURCE_BRANCH_NAME 13.10 所有 合并请求的源分支名称。
CI_MERGE_REQUEST_SOURCE_BRANCH_PROTECTED 当合并分支是受保护的，则为 true。引入于极狐GitLab 16.4。    
CI_MERGE_REQUEST_SOURCE_BRANCH_SHA 13.10 所有 合并请求的源分支的 HEAD SHA。该变量在合并请求流水线中为空。SHA 仅存在于合并结果流水线中。
CI_MERGE_REQUEST_SOURCE_PROJECT_ID 13.10 所有 合并请求的源项目的 ID。
CI_MERGE_REQUEST_SOURCE_PROJECT_PATH 13.10 所有 合并请求的源项目路径。
CI_MERGE_REQUEST_SOURCE_PROJECT_URL 13.10 所有 合并请求的源项目的 URL。
CI_MERGE_REQUEST_SQUASH_ON_MERGE 在合并请求上压缩选项上被设置为 true。引入于极狐GitLab 16.4。    
CI_MERGE_REQUEST_TARGET_BRANCH_NAME 13.10 所有 合并请求的目标分支名称。
CI_MERGE_REQUEST_TARGET_BRANCH_PROTECTED 15.2 所有 合并请求的目标分支的保护状态。
CI_MERGE_REQUEST_TARGET_BRANCH_SHA 13.10 所有 合并请求的目标分支的 HEAD SHA。该变量在合并请求流水线中为空。SHA 仅存在于合并结果流水线中。
CI_MERGE_REQUEST_TITLE 13.10 所有 合并请求的标题。

外部拉取请求流水线的预定义变量

这些变量仅在以下情况下可用：

  • 流水线是外部拉取请求流水线
  • 拉取请求是开放的。
变量 极狐GitLab Runner 描述
CI_EXTERNAL_PULL_REQUEST_IID 13.10 所有 从 GitHub 拉取请求 ID。
CI_EXTERNAL_PULL_REQUEST_SOURCE_REPOSITORY 13.3 所有 拉取请求的源仓库名称。
CI_EXTERNAL_PULL_REQUEST_TARGET_REPOSITORY 13.3 所有 拉取请求的目标仓库名称。
CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_NAME 13.10 所有 拉取请求的源分支名称。
CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_SHA 13.10 所有 拉取请求源分支的 HEAD SHA。
CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_NAME 13.10 所有 拉取请求的目标分支名称。
CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_SHA 13.10 所有 拉取请求目标分支的 HEAD SHA。

部署变量

负责部署配置的集成可以定义在构建环境中设置的自己的预定义变量。这些变量仅为部署作业定义。

例如，Kubernetes 集成定义了可用于集成的部署变量。

每个集成的文档解释了集成是否有可用的部署变量。

Auto DevOps 变量

当启用 Auto DevOps 时，将提供一些额外的预流水线变量：

集成变量

有些集成在作业中提供变量。这些变量作为仅作业预定义变量提供：

  • Harbor:
    • HARBOR_URL
    • HARBOR_HOST
    • HARBOR_OCI
    • HARBOR_PROJECT
    • HARBOR_USERNAME
    • HARBOR_PASSWORD
  • Apple App Store Connect:
    • APP_STORE_CONNECT_API_KEY_ISSUER_ID
    • APP_STORE_CONNECT_API_KEY_KEY_ID
    • APP_STORE_CONNECT_API_KEY_KEY
    • APP_STORE_CONNECT_API_KEY_IS_KEY_CONTENT_BASE64 <!– - Google Play:
    • SUPPLY_PACKAGE_NAME
    • SUPPLY_JSON_KEY_DATA –>
  • Diffblue Cover:
    • DIFFBLUE_LICENSE_KEY
    • DIFFBLUE_ACCESS_TOKEN_NAME
    • DIFFBLUE_ACCESS_TOKEN

故障排查

您可以使用 script 命令输出作业可用的所有变量的值。