Predefined environment variables reference

原文：https://docs.gitlab.com/ee/ci/variables/predefined_variables.html

Predefined environment variables reference

有关此主题的介绍，请通读环境变量入门文档.

仅当使用最低版本的GitLab Runner 时，某些预定义的环境变量才可用. 请查阅下表以查找所需的 Runner 版本.

注意：从 GitLab 9.0 开始，我们已弃用了一些变量. 阅读9.0 重命名部分以查找其替换内容. 强烈建议您使用新变量，因为我们将在以后的 GitLab 版本中删除旧变量.

您可以在.gitlab-ci.yml文件中添加命令，以输出可用于作业的所有变量的值 .

Kubernetes 特定于环境的环境变量在Kubernetes 部署变量部分中进行了详细介绍.

Variable	GitLab	Runner	Description
`CHAT_CHANNEL`	10.6	all	触发ChatOps命令的源聊天通道
`CHAT_INPUT`	10.6	all	在ChatOps命令中传递的其他参数
`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	是否启用调试日志记录（跟踪）
`CI_DEFAULT_BRANCH`	12.4	all	项目的默认分支的名称.
`CI_DEPLOY_PASSWORD`	10.8	all	GitLab Deploy 令牌的身份验证密码，仅在项目具有相关性时才提供.
`CI_DEPLOY_USER`	10.8	all	GitLab Deploy 令牌的身份验证用户名，仅在项目具有相关性时才存在.
`CI_DISPOSABLE_ENVIRONMENT`	all	10.1	标记作业是在一次性环境中执行的（仅为该作业创建并在执行后处置/销毁的东西-除`shell`和`ssh`以外的所有执行程序）. 如果环境是一次性的，则将其设置为 true，否则将完全未定义.
`CI_ENVIRONMENT_NAME`	8.15	all	该作业的环境名称. 仅在设置了`environment:name`存在.
`CI_ENVIRONMENT_SLUG`	8.15	all	环境名称的简化版本，适合包含在 DNS，URL，Kubernetes 标签等中.仅在设置了`environment:name`存在.
`CI_ENVIRONMENT_URL`	9.3	all	该作业的环境的 URL. 仅当设置了`environment:url`时才存在.
`CI_EXTERNAL_PULL_REQUEST_IID`	12.3	all	如果管道用于外部请求，则来自 GitHub 的请求请求 ID. 仅在以下情况`only: [external_pull_requests]`可用`only: [external_pull_requests]`或`rules`语法，并且拉取请求处于打开状态.
`CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_NAME`	12.3	all	如果管道用于外部请求，则请求请求的源分支名称. 仅在以下情况`only: [external_pull_requests]`可用`only: [external_pull_requests]`或`rules`语法，并且拉取请求处于打开状态.
`CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_SHA`	12.3	all	如果管道用于外部请求，则请求请求的源分支的 HEAD SHA. 仅在以下情况`only: [external_pull_requests]`可用`only: [external_pull_requests]`或`rules`语法，并且拉取请求处于打开状态.
`CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_NAME`	12.3	all	如果管道用于外部请求，则请求请求的目标分支名称. 仅在以下情况`only: [external_pull_requests]`可用`only: [external_pull_requests]`或`rules`语法，并且拉取请求处于打开状态.
`CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_SHA`	12.3	all	如果管道用于外部请求，则请求请求目标分支的 HEAD SHA. 仅在以下情况`only: [external_pull_requests]`可用`only: [external_pull_requests]`或`rules`语法，并且拉取请求处于打开状态.
`CI_HAS_OPEN_REQUIREMENTS`	13.1	all	仅当管道的项目有任何开放要求时，才将值包括为`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 容器注册表进行身份验证，下载从属存储库以及访问GitLab 管理的 Terraform 状态的令牌.
`CI_JOB_JWT`	12.10	all	RS256 JSON Web 令牌，可用于与支持 JWT 身份验证的第三方系统进行身份验证，例如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` with `rules:if`
`CI_MERGE_REQUEST_ASSIGNEES`	11.9	all	如果管道用于合并请求，则该合并请求的受让人的用户名列表用逗号分隔. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_ID`	11.6	all	合并请求的项目级别 ID. 仅当管道用于合并请求并且创建合并请求时才可用.
`CI_MERGE_REQUEST_IID`	11.6	all	合并请求的实例级 IID. 仅当管道用于合并请求并且创建合并请求时才可用.
`CI_MERGE_REQUEST_LABELS`	11.9	all	如果管道用于合并请求，则合并请求的逗号分隔标签名称. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_MILESTONE`	11.9	all	如果管道用于合并请求，则合并请求的里程碑标题. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_PROJECT_ID`	11.6	all	如果管道用于合并请求，则合并请求的项目的 ID. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_PROJECT_PATH`	11.6	all	如果管道用于合并请求，则合并请求的项目路径（例如， `namespace/awesome-project` ）. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_PROJECT_URL`	11.6	all	如果管道用于合并请求，则合并请求的项目的 URL（例如`http://192.168.10.15:3000/namespace/awesome-project` ）. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_REF_PATH`	11.6	all	如果管道用于合并请求，则合并请求的 ref 路径. （例如`refs/merge-requests/1/head` ）. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_SOURCE_BRANCH_NAME`	11.6	all	如果管道用于合并请求，则合并请求的源分支名称. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_SOURCE_BRANCH_SHA`	11.9	all	如果管道用于合并请求，则合并请求的源分支的 HEAD SHA. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法，创建合并请求，并且管道是合并结果管道 .
`CI_MERGE_REQUEST_SOURCE_PROJECT_ID`	11.6	all	如果管道用于合并请求，则合并请求的源项目的 ID. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_SOURCE_PROJECT_PATH`	11.6	all	如果管道用于合并请求，则合并请求的源项目的路径. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_SOURCE_PROJECT_URL`	11.6	all	如果管道用于合并请求，则合并请求的源项目的 URL. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_TARGET_BRANCH_NAME`	11.6	all	如果管道用于合并请求，则合并请求的目标分支名称. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_TARGET_BRANCH_SHA`	11.9	all	如果管道用于合并请求，则合并请求的目标分支的 HEAD SHA. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法，创建合并请求，并且管道是合并结果管道 .
`CI_MERGE_REQUEST_TITLE`	11.9	all	如果管道用于合并请求，则合并请求的标题. 仅在以下情况`only: [merge_requests]`可用：仅使用`only: [merge_requests]`或`rules`语法并创建合并请求.
`CI_MERGE_REQUEST_EVENT_TYPE`	12.3	all	合并请求的事件类型（如果管道用于合并请求） . 可以`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` （自 13.0 起改名为`cross_project_pipeline` ）. 对于在 GitLab 9.5 之前创建的管道，这将显示为`unknown` .
`CI_PIPELINE_TRIGGERED`	all	all	指示已触发作业的标志
`CI_PIPELINE_URL`	11.1	0.5	管道详细资料网址
`CI_PROJECT_DIR`	all	all	克隆存储库以及运行作业的完整路径. 如果设置了 GitLab Runner 的`builds_dir`参数，则相对于`builds_dir`的值设置此变量. 有关更多信息，请参见 GitLab Runner 的高级配置 .
`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	开始工作的用户的真实姓名

Predefined environment variables reference

Predefined environment variables reference

Predefined environment variables reference

results matching ""

No results matching ""