{{< details >}}
- Tier: 基础版, 专业版, 旗舰版
- Offering: JihuLab.com, 私有化部署
{{< /details >}}
预定义的 CI/CD 变量 在每个极狐GitLab CI/CD 流水线中都可用。
避免 覆盖 预定义变量,因为这可能导致流水线行为异常。
变量可用性
预定义变量在流水线执行的三个不同阶段变得可用:
- Pre-pipeline: Pre-pipeline 变量在创建流水线之前可用。这些变量是唯一可以与
include:rules
一起使用的变量,用于控制创建流水线时使用哪些配置文件。 - Pipeline: 流水线变量在极狐GitLab 创建流水线时变得可用。除了 Pre-pipeline 变量外,流水线变量还可以用于配置在作业中定义的
rules
,以确定要添加到流水线中的作业。 - Job-only: 当 runner 拾取并运行作业时,这些变量仅在每个作业中可用,并且:
预定义变量
变量 | 可用性 | 描述 |
---|---|---|
CHAT_CHANNEL |
流水线 | 触发 ChatOps 命令的来源聊天频道。 |
CHAT_INPUT |
流水线 | 与 ChatOps 命令一起传递的附加参数。 |
CHAT_USER_ID |
流水线 | 触发 ChatOps 命令的用户的聊天服务用户 ID。 |
CI |
Pre-pipeline | 在 CI/CD 中执行的所有作业中可用。可用时为 true 。 |
CI_API_V4_URL |
Pre-pipeline | 极狐GitLab API v4 根 URL。 |
CI_API_GRAPHQL_URL |
Pre-pipeline | 极狐GitLab API GraphQL 根 URL。 |
CI_BUILDS_DIR |
Job-only | 执行构建的顶级目录。 |
CI_COMMIT_AUTHOR |
Pre-pipeline | 提交的作者,格式为 Name <email> 。 |
CI_COMMIT_BEFORE_SHA |
Pre-pipeline | 分支或标签上的前一个最新提交。对于合并请求流水线、计划的流水线、分支或标签的第一次提交或手动运行流水线时,始终为 0000000000000000000000000000000000000000 。 |
CI_COMMIT_BRANCH |
Pre-pipeline | 提交分支名称。在分支流水线中可用,包括默认分支的流水线。在合并请求流水线或标签流水线中不可用。 |
CI_COMMIT_DESCRIPTION |
Pre-pipeline | 提交的描述。如果标题少于 100 个字符,则为消息中不包括第一行的部分。 |
CI_COMMIT_MESSAGE |
Pre-pipeline | 完整的提交消息。 |
CI_COMMIT_REF_NAME |
Pre-pipeline | 项目构建的分支或标签名称。 |
CI_COMMIT_REF_PROTECTED |
Pre-pipeline | 如果作业正在为受保护的引用运行,则为 true ,否则为 false 。 |
CI_COMMIT_REF_SLUG |
Pre-pipeline |
CI_COMMIT_REF_NAME 的小写形式,缩短至 63 字节,并将除 0-9 和 a-z 外的所有字符替换为 - 。无前导 / 尾随 - 。用于 URL、主机名和域名。 |
CI_COMMIT_SHA |
Pre-pipeline | 项目构建的提交版本。 |
CI_COMMIT_SHORT_SHA |
Pre-pipeline |
CI_COMMIT_SHA 的前八个字符。 |
CI_COMMIT_TAG |
Pre-pipeline | 提交标签名称。仅在标签的流水线中可用。 |
CI_COMMIT_TAG_MESSAGE |
Pre-pipeline | 提交标签消息。仅在标签的流水线中可用。 |
CI_COMMIT_TIMESTAMP |
Pre-pipeline | 提交的时间戳,格式为 ISO 8601。例如 2022-01-31T16:47:55Z 。默认 UTC。 |
CI_COMMIT_TITLE |
Pre-pipeline | 提交的标题。消息的完整第一行。 |
CI_CONCURRENT_ID |
Job-only | 单个执行器中构建执行的唯一 ID。 |
CI_CONCURRENT_PROJECT_ID |
Job-only | 单个执行器和项目中构建执行的唯一 ID。 |
CI_CONFIG_PATH |
Pre-pipeline | CI/CD 配置文件的路径。默认为 .gitlab-ci.yml 。 |
CI_DEBUG_TRACE |
流水线 | 如果启用了 调试日志记录(跟踪),则为 true 。 |
CI_DEBUG_SERVICES |
流水线 | 如果启用了 服务容器日志记录,则为 true 。需要极狐GitLab Runner 15.7。 |
CI_DEFAULT_BRANCH |
Pre-pipeline | 项目的默认分支名称。 |
CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX |
Pre-pipeline | 通过依赖代理拉取图像的直接群组图像前缀。 |
CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX |
Pre-pipeline | 通过依赖代理拉取图像的顶级群组图像前缀。 |
CI_DEPENDENCY_PROXY_PASSWORD |
流水线 | 通过依赖代理拉取图像的密码。 |
CI_DEPENDENCY_PROXY_SERVER |
Pre-pipeline | 登录依赖代理的服务器。此变量等同于 $CI_SERVER_HOST:$CI_SERVER_PORT 。 |
CI_DEPENDENCY_PROXY_USER |
流水线 | 通过依赖代理拉取图像的用户名。 |
CI_DEPLOY_FREEZE |
Pre-pipeline | 仅当流水线在 部署冻结窗口 期间运行时可用。可用时为 true 。 |
CI_DEPLOY_PASSWORD |
Job-only | 极狐GitLab 部署令牌 的认证密码(如果项目有的话)。 |
CI_DEPLOY_USER |
Job-only | 极狐GitLab 部署令牌 的认证用户名(如果项目有的话)。 |
CI_DISPOSABLE_ENVIRONMENT |
流水线 | 仅当作业在一次性环境中执行时可用(仅为此作业创建的环境,在执行后处置/销毁 - 除 shell 和 ssh 外的所有执行器)。可用时为 true 。 |
CI_ENVIRONMENT_NAME |
流水线 | 此作业的环境名称。如果设置了 environment:name ,则可用。 |
CI_ENVIRONMENT_SLUG |
流水线 | 环境名称的简化版本,适合包括在 DNS、URL、Kubernetes 标签等中。如果设置了 environment:name ,则可用。 |
CI_ENVIRONMENT_URL |
流水线 | 此作业的环境 URL。如果设置了 environment:url ,则可用。 |
CI_ENVIRONMENT_ACTION |
流水线 | 此作业环境指定的动作注释。如果设置了 environment:action ,则可用。可以是 start 、prepare 或 stop 。 |
CI_ENVIRONMENT_TIER |
流水线 | 此作业环境的 部署层级。 |
CI_GITLAB_FIPS_MODE |
Pre-pipeline | 仅当在极狐GitLab 实例中启用了 FIPS 模式 时可用。可用时为 true 。 |
CI_HAS_OPEN_REQUIREMENTS |
流水线 | 仅当流水线的项目有开放的 需求 时可用。可用时为 true 。 |
CI_JOB_GROUP_NAME |
流水线 | 作业组的共享名称,当使用 parallel 或 手动分组作业 时。例如,如果作业名称是 rspec:test: [ruby, ubuntu] ,则 CI_JOB_GROUP_NAME 是 rspec:test 。否则与 CI_JOB_NAME 相同。 |
CI_JOB_ID |
Job-only | 作业的内部 ID,在极狐GitLab 实例中的所有作业中唯一。 |
CI_JOB_IMAGE |
流水线 | 运行作业的 Docker 镜像名称。 |
CI_JOB_MANUAL |
流水线 | 仅当作业是手动启动时可用。可用时为 true 。 |
CI_JOB_NAME |
流水线 | 作业的名称。 |
CI_JOB_NAME_SLUG |
流水线 |
CI_JOB_NAME 的小写形式,缩短至 63 字节,并将除 0-9 和 a-z 外的所有字符替换为 - 。无前导 / 尾随 - 。用于路径。 |
CI_JOB_STAGE |
流水线 | 作业的阶段名称。 |
CI_JOB_STATUS |
Job-only | 在执行每个 runner 阶段时作业的状态。与 after_script 一起使用。可以是 success 、failed 或 canceled 。 |
CI_JOB_TIMEOUT |
Job-only | 作业超时时间,以秒为单位。 |
CI_JOB_TOKEN |
Job-only | 使用 某些 API 端点 进行身份验证的令牌。令牌在作业运行时有效。 |
CI_JOB_URL |
Job-only | 作业详情 URL。 |
CI_JOB_STARTED_AT |
Job-only | 作业开始的日期和时间,格式为 ISO 8601。例如 2022-01-31T16:47:55Z 。默认 UTC。 |
CI_KUBERNETES_ACTIVE |
Pre-pipeline | 仅当流水线有可用于部署的 Kubernetes 集群时可用。可用时为 true 。 |
CI_NODE_INDEX |
流水线 | 作业集中的作业索引。仅当作业使用 parallel 时可用。 |
CI_NODE_TOTAL |
流水线 | 并行运行此作业的实例总数。如果作业不使用 parallel ,则设置为 1 。 |
CI_OPEN_MERGE_REQUESTS |
Pre-pipeline | 一个逗号分隔的最多四个合并请求的列表,这些请求使用当前分支和项目作为合并请求源。仅在分支和合并请求流水线中,如果分支有相关的合并请求时可用。例如 gitlab-org/gitlab!333,gitlab-org/gitlab-foss!11 。 |
CI_PAGES_DOMAIN |
Pre-pipeline | 托管极狐GitLab Pages 的实例域,不包括命名空间子域。要使用完整的主机名,请改用 CI_PAGES_HOSTNAME 。 |
CI_PAGES_HOSTNAME |
Job-only | Pages 部署的完整主机名。 |
CI_PAGES_URL |
Job-only | 极狐GitLab Pages 站点的 URL。始终是 CI_PAGES_DOMAIN 的子域。在极狐GitLab 17.9 及更高版本中,值包括指定的 path_prefix 。 |
CI_PIPELINE_ID |
Job-only | 当前流水线的实例级 ID。此 ID 在极狐GitLab 实例中的所有项目中唯一。 |
CI_PIPELINE_IID |
流水线 | 当前流水线的项目级 IID(内部 ID)。此 ID 仅在当前项目中唯一。 |
CI_PIPELINE_SOURCE |
Pre-pipeline | 流水线的触发方式。值可以是 流水线源之一。 |
CI_PIPELINE_TRIGGERED |
流水线 | 如果作业是 触发的,则为 true 。 |
CI_PIPELINE_URL |
Job-only | 流水线详情的 URL。 |
CI_PIPELINE_CREATED_AT |
Pre-pipeline | 流水线创建的日期和时间,格式为 ISO 8601。例如 2022-01-31T16:47:55Z 。默认 UTC。 |
CI_PIPELINE_NAME |
Pre-pipeline | 在 workflow:name 中定义的流水线名称。 |
CI_PIPELINE_SCHEDULE_DESCRIPTION |
Pre-pipeline | 流水线计划的描述。仅在计划的流水线中可用。 |
CI_PROJECT_DIR |
Job-only | 仓库克隆到的完整路径,以及作业运行的位置。如果极狐GitLab Runner 的 builds_dir 参数已设置,则此变量相对于 builds_dir 的值设置。有关更多信息,请参阅 高级极狐GitLab Runner 配置。 |
CI_PROJECT_ID |
Pre-pipeline | 当前项目的 ID。此 ID 在极狐GitLab 实例中的所有项目中唯一。 |
CI_PROJECT_NAME |
Pre-pipeline | 项目的目录名称。例如,如果项目 URL 是 gitlab.example.com/group-name/project-1 ,则 CI_PROJECT_NAME 是 project-1 。 |
CI_PROJECT_NAMESPACE |
Pre-pipeline | 作业的项目命名空间(用户名或群组名称)。 |
CI_PROJECT_NAMESPACE_ID |
Pre-pipeline | 作业的项目命名空间 ID。 |
CI_PROJECT_NAMESPACE_SLUG |
Pre-pipeline |
$CI_PROJECT_NAMESPACE 的小写形式,字符不是 a-z 或 0-9 的替换为 - 并缩短至 63 字节。 |
CI_PROJECT_PATH_SLUG |
Pre-pipeline |
$CI_PROJECT_PATH 的小写形式,字符不是 a-z 或 0-9 的替换为 - 并缩短至 63 字节。用于 URL 和域名。 |
CI_PROJECT_PATH |
Pre-pipeline | 项目命名空间,包含项目名称。 |
CI_PROJECT_REPOSITORY_LANGUAGES |
Pre-pipeline | 仓库中使用的语言的逗号分隔、小写列表。例如 ruby,javascript,html,css 。语言的最大数量限制为 5。 |
CI_PROJECT_ROOT_NAMESPACE |
Pre-pipeline | 作业的根项目命名空间(用户名或群组名称)。例如,如果 CI_PROJECT_NAMESPACE 是 root-group/child-group/grandchild-group ,则 CI_PROJECT_ROOT_NAMESPACE 是 root-group 。 |
CI_PROJECT_TITLE |
Pre-pipeline | 在极狐GitLab Web 界面中显示的项目名称。 |
CI_PROJECT_DESCRIPTION |
Pre-pipeline | 在极狐GitLab Web 界面中显示的项目描述。 |
CI_PROJECT_URL |
Pre-pipeline | 项目的 HTTP(S) 地址。 |
CI_PROJECT_VISIBILITY |
Pre-pipeline | 项目的可见性。可以是 internal 、private 或 public 。 |
CI_PROJECT_CLASSIFICATION_LABEL |
Pre-pipeline | 项目 外部授权分类标签。 |
CI_REGISTRY |
Pre-pipeline |
容器镜像仓库 服务器的地址,格式为 <host>[:<port>] 。例如:registry.gitlab.example.com 。仅当极狐GitLab 实例启用容器镜像仓库时可用。 |
CI_REGISTRY_IMAGE |
Pre-pipeline | 用于推送、拉取或标记项目图像的容器镜像仓库基地址,格式为 <host>[:<port>]/<project_full_path> 。例如:registry.gitlab.example.com/my_group/my_project 。图像名称必须遵循 容器镜像仓库命名约定。仅当项目启用容器镜像仓库时可用。 |
CI_REGISTRY_PASSWORD |
Job-only | 向极狐GitLab 项目的容器镜像仓库推送容器的密码。仅当项目启用容器镜像仓库时可用。此密码值与 CI_JOB_TOKEN 相同,并且仅在作业运行时有效。使用 CI_DEPLOY_PASSWORD 进行长期访问注册表。 |
CI_REGISTRY_USER |
Job-only | 向项目的极狐GitLab 容器镜像仓库推送容器的用户名。仅当项目启用容器镜像仓库时可用。 |
CI_RELEASE_DESCRIPTION |
流水线 | 发布的描述。仅在标签的流水线上可用。描述长度限制为前 1024 个字符。 |
CI_REPOSITORY_URL |
Job-only | 使用 CI/CD 作业令牌 克隆(HTTP)仓库的完整路径,格式为 https://gitlab-ci-token:$CI_JOB_TOKEN@gitlab.example.com/my-group/my-project.git 。 |
CI_RUNNER_DESCRIPTION |
Job-only | runner 的描述。 |
CI_RUNNER_EXECUTABLE_ARCH |
Job-only | 极狐GitLab Runner 可执行文件的操作系统/架构。可能与执行器环境不同。 |
CI_RUNNER_ID |
Job-only | 正在使用的 runner 的唯一 ID。 |
CI_RUNNER_REVISION |
Job-only | 正在运行作业的 runner 的修订版本。 |
CI_RUNNER_SHORT_TOKEN |
Job-only | runner 的唯一 ID,用于认证新的作业请求。令牌包含前缀,并使用前 17 个字符。 |
CI_RUNNER_TAGS |
Job-only | runner 标签的 JSON 数组。例如 ["tag_1", "tag_2"] 。 |
CI_RUNNER_VERSION |
Job-only | 正在运行作业的极狐GitLab Runner 的版本。 |
CI_SERVER_FQDN |
Pre-pipeline | 实例的完全合格域名(FQDN)。例如 gitlab.example.com:8080 。 |
CI_SERVER_HOST |
Pre-pipeline | 极狐GitLab 实例 URL 的主机,不包括协议或端口。例如 gitlab.example.com 。 |
CI_SERVER_NAME |
Pre-pipeline | 协调作业的 CI/CD 服务器的名称。 |
CI_SERVER_PORT |
Pre-pipeline | 极狐GitLab 实例 URL 的端口,不包括主机或协议。例如 8080 。 |
CI_SERVER_PROTOCOL |
Pre-pipeline | 极狐GitLab 实例 URL 的协议,不包括主机或端口。例如 https 。 |
CI_SERVER_SHELL_SSH_HOST |
Pre-pipeline | 极狐GitLab 实例的 SSH 主机,用于通过 SSH 访问 Git 仓库。例如 gitlab.com 。 |
CI_SERVER_SHELL_SSH_PORT |
Pre-pipeline | 极狐GitLab 实例的 SSH 端口,用于通过 SSH 访问 Git 仓库。例如 22 。 |
CI_SERVER_REVISION |
Pre-pipeline | 调度作业的极狐GitLab 修订版本。 |
CI_SERVER_TLS_CA_FILE |
流水线 | 文件包含 TLS CA 证书,用于在 runner 设置中设置 tls-ca-file 时验证极狐GitLab 服务器。 |
CI_SERVER_TLS_CERT_FILE |
流水线 | 文件包含 TLS 证书,用于在 runner 设置中设置 tls-cert-file 时验证极狐GitLab 服务器。 |
CI_SERVER_TLS_KEY_FILE |
流水线 | 文件包含 TLS 密钥,用于在 runner 设置中设置 tls-key-file 时验证极狐GitLab 服务器。 |
CI_SERVER_URL |
Pre-pipeline | 极狐GitLab 实例的基本 URL,包括协议和端口。例如 https://gitlab.example.com:8080 。 |
CI_SERVER_VERSION_MAJOR |
Pre-pipeline | 极狐GitLab 实例的主要版本。例如,如果极狐GitLab 版本是 17.2.1 ,则 CI_SERVER_VERSION_MAJOR 是 17 。 |
CI_SERVER_VERSION_MINOR |
Pre-pipeline | 极狐GitLab 实例的次要版本。例如,如果极狐GitLab 版本是 17.2.1 ,则 CI_SERVER_VERSION_MINOR 是 2 。 |
CI_SERVER_VERSION_PATCH |
Pre-pipeline | 极狐GitLab 实例的补丁版本。例如,如果极狐GitLab 版本是 17.2.1 ,则 CI_SERVER_VERSION_PATCH 是 1 。 |
CI_SERVER_VERSION |
Pre-pipeline | 极狐GitLab 实例的完整版本。 |
CI_SERVER |
Job-only | 在 CI/CD 中执行的所有作业中可用。可用时为 yes 。 |
CI_SHARED_ENVIRONMENT |
流水线 | 仅当作业在共享环境中执行时可用(在 CI/CD 调用中持久化的环境,如 shell 或 ssh 执行器)。可用时为 true 。 |
CI_TEMPLATE_REGISTRY_HOST |
Pre-pipeline | CI/CD 模板使用的注册表的主机。默认为 registry.gitlab.com 。 |
CI_TRIGGER_SHORT_TOKEN |
Job-only | 当前作业的 触发令牌 的前四个字符。仅当流水线是 使用触发令牌触发的 时可用。例如,对于触发令牌 glptt-1234567890abcdefghij ,CI_TRIGGER_SHORT_TOKEN 将是 1234 。 |
GITLAB_CI |
Pre-pipeline | 在 CI/CD 中执行的所有作业中可用。可用时为 true 。 |
GITLAB_FEATURES |
Pre-pipeline | 极狐GitLab 实例和许可证可用的许可功能的逗号分隔列表。 |
GITLAB_USER_EMAIL |
流水线 | 启动流水线的用户的电子邮件,除非作业是手动作业。在手动作业中,值是启动作业的用户的电子邮件。 |
GITLAB_USER_ID |
流水线 | 启动流水线的用户的数字 ID,除非作业是手动作业。在手动作业中,值是启动作业的用户的 ID。 |
GITLAB_USER_LOGIN |
流水线 | 启动流水线的用户的唯一用户名,除非作业是手动作业。在手动作业中,值是启动作业的用户的用户名。 |
GITLAB_USER_NAME |
流水线 | 启动流水线的用户的显示名称(用户在个人资料设置中定义的 全名),除非作业是手动作业。在手动作业中,值是启动作业的用户的名称。 |
KUBECONFIG |
流水线 | 带有所有共享代理连接上下文的 kubeconfig 文件的路径。仅当 极狐GitLab 代理被授权访问项目 时可用。 |
TRIGGER_PAYLOAD |
流水线 | Webhook 负载。仅当流水线是 使用 Webhook 触发的 时可用。 |
合并请求流水线的预定义变量
这些变量在极狐GitLab 创建流水线之前可用(Pre-pipeline)。这些变量可以与
include:rules
一起使用,并作为作业中的环境变量。
流水线必须是 合并请求流水线,且合并请求必须是打开的。
变量 | 描述 |
---|---|
CI_MERGE_REQUEST_APPROVED |
合并请求的审批状态。当 合并请求审批 可用且合并请求已批准时为 true 。 |
CI_MERGE_REQUEST_ASSIGNEES |
合并请求分配的用户名的逗号分隔列表。仅当合并请求至少有一个分配时可用。 |
CI_MERGE_REQUEST_DIFF_BASE_SHA |
合并请求差异的基 SHA。 |
CI_MERGE_REQUEST_DIFF_ID |
合并请求差异的版本。 |
CI_MERGE_REQUEST_EVENT_TYPE |
合并请求的事件类型。可以是 detached 、merged_result 或 merge_train 。 |
CI_MERGE_REQUEST_DESCRIPTION |
合并请求的描述。如果描述超过 2700 个字符,则仅存储变量中的前 2700 个字符。 |
CI_MERGE_REQUEST_DESCRIPTION_IS_TRUNCATED |
如果 CI_MERGE_REQUEST_DESCRIPTION 被截断至 2700 个字符,因为合并请求的描述太长,则为 true ,否则为 false 。 |
CI_MERGE_REQUEST_ID |
合并请求的实例级 ID。此 ID 在极狐GitLab 实例中的所有项目中唯一。 |
CI_MERGE_REQUEST_IID |
合并请求的项目级 IID(内部 ID)。此 ID 在当前项目中唯一,是合并请求 URL、页面标题和其他可见位置中使用的数字。 |
CI_MERGE_REQUEST_LABELS |
合并请求的标签名称的逗号分隔列表。仅当合并请求至少有一个标签时可用。 |
CI_MERGE_REQUEST_MILESTONE |
合并请求的里程碑标题。仅当合并请求设有里程碑时可用。 |
CI_MERGE_REQUEST_PROJECT_ID |
合并请求的项目 ID。 |
CI_MERGE_REQUEST_PROJECT_PATH |
合并请求的项目路径。例如 namespace/awesome-project 。 |
CI_MERGE_REQUEST_PROJECT_URL |
合并请求的项目 URL。例如 http://192.168.10.15:3000/namespace/awesome-project 。 |
CI_MERGE_REQUEST_REF_PATH |
合并请求的引用路径。例如 refs/merge-requests/1/head 。 |
CI_MERGE_REQUEST_SOURCE_BRANCH_NAME |
合并请求的来源分支名称。 |
CI_MERGE_REQUEST_SOURCE_BRANCH_PROTECTED |
当合并请求的来源分支是 受保护的 时为 true 。 |
CI_MERGE_REQUEST_SOURCE_BRANCH_SHA |
合并请求的来源分支的 HEAD SHA。变量在合并请求流水线中为空。SHA 仅在 合并结果流水线 中存在。 |
CI_MERGE_REQUEST_SOURCE_PROJECT_ID |
合并请求的来源项目 ID。 |
CI_MERGE_REQUEST_SOURCE_PROJECT_PATH |
合并请求的来源项目路径。 |
CI_MERGE_REQUEST_SOURCE_PROJECT_URL |
合并请求的来源项目 URL。 |
CI_MERGE_REQUEST_SQUASH_ON_MERGE |
如果设置了 合并时压缩 选项,则为 true 。 |
CI_MERGE_REQUEST_TARGET_BRANCH_NAME |
合并请求的目标分支名称。 |
CI_MERGE_REQUEST_TARGET_BRANCH_PROTECTED |
当合并请求的目标分支是 受保护的 时为 true 。 |
CI_MERGE_REQUEST_TARGET_BRANCH_SHA |
合并请求的目标分支的 HEAD SHA。变量在合并请求流水线中为空。SHA 仅在 合并结果流水线 中存在。 |
CI_MERGE_REQUEST_TITLE |
合并请求的标题。 |
CI_MERGE_REQUEST_DRAFT |
如果合并请求是草稿,则为 true 。 |
外部拉取请求流水线的预定义变量
这些变量仅在以下情况下可用:
- 流水线是 外部拉取请求流水线
- 拉取请求是打开的。
变量 | 描述 |
---|---|
CI_EXTERNAL_PULL_REQUEST_IID |
来自 GitHub 的拉取请求 ID。 |
CI_EXTERNAL_PULL_REQUEST_SOURCE_REPOSITORY |
拉取请求的来源仓库名称。 |
CI_EXTERNAL_PULL_REQUEST_TARGET_REPOSITORY |
拉取请求的目标仓库名称。 |
CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_NAME |
拉取请求的来源分支名称。 |
CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_SHA |
拉取请求的来源分支的 HEAD SHA。 |
CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_NAME |
拉取请求的目标分支名称。 |
CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_SHA |
拉取请求的目标分支的 HEAD SHA。 |
部署变量
负责部署配置的集成可以定义在构建环境中设置的自己的预定义变量。这些变量仅为 部署作业 定义。
例如,Kubernetes 集成 定义了可以与该集成一起使用的部署变量。
每个集成的文档 说明了该集成是否有可用的部署变量。
自动 DevOps 变量
当 自动 DevOps 启用时,一些附加的 pre-pipeline 变量变得可用:
-
AUTO_DEVOPS_EXPLICITLY_ENABLED
: 值为1
,表示自动 DevOps 已启用。 -
STAGING_ENABLED
: 请参阅 自动 DevOps 部署策略。 -
INCREMENTAL_ROLLOUT_MODE
: 请参阅 自动 DevOps 部署策略。 -
INCREMENTAL_ROLLOUT_ENABLED
: 已弃用。
集成变量
一些集成使变量在作业中可用。这些变量作为 仅作业预定义变量 可用:
-
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
命令 输出作业可用的所有变量的值。