流水线 / 在线配置流水线 / 环境变量

环境变量

文章内容

功能介绍
自定义环境变量
系统内置的环境变量

功能介绍

在使用流水线的过程中总会需要使用到一些配置信息，例如账号密码、版本号等。将这些信息以环境变量的形式注入至流水线中，既能实现敏感信息的安全加密，也更加易于统一管理项目资源。您可以同时使用以下几种方式来为构建过程注入环境变量：

自定义环境变量
系统内置的环境变量

下文将详细介绍这几种方式的详细说明。

自定义环境变量

流水线支持添加以下四种类别的环境变量：字符串、单选、多选、CODING 凭据，这些环境变量可以被视为启动参数的默认值。在流水线详情中的“构建环境”添加环境变量。

系统内置的环境变量

流水线的实际运行会为每一个流程注入系统内置的环境变量，这些内置变量确保流水线能够正常运行。默认注入的环境变量列表可以在“系统变量”中查看。

所有环境变量汇总如下，按照不同的触发规则（代码更新时触发、定时触发、合并请求时触发）进行分类介绍：

序号	变量名	变量含义	代码更新时触发	定时触发	合并请求时触发
1	CREDENTIALS_ID	部署私钥凭据 CredentialsId 用于拉取仓库	✅	✅	✅
2	DOCKER_REGISTRY_CREDENTIALS_ID	docker 私钥凭据 CredentialsId（等同于 CODING_ARTIFACTS_CREDENTIALS_ID）	✅	✅	✅
3	CODING_ARTIFACTS_CREDENTIALS_ID	制品库私钥凭据 CredentialsId 用于拉取项目内的制品库	✅	✅	✅
4	GIT_HTTP_URL	HTTPS 协议代码仓库地址	✅	✅	✅
5	GIT_BUILD_REF	构建对应的 Git 修订版本号	✅	✅	✅
6	GIT_DEPLOY_KEY	代码仓库的部署公钥	✅	✅	✅
7	GIT_COMMIT	当前版本的修订版本号	✅	✅	✅
7	GIT_COMMIT_SHORT	修订版本号的前 7 位	✅	✅	✅
8	GIT_PREVIOUS_COMMIT	前一个构建运行编号的修订版本号	✅	✅	✅
9	GIT_AUTHOR_EMAIL	本版本最新提交作者邮箱	✅	✅	✅
10	GIT_SSH_URL	协议代码仓库地址	✅	✅	✅
11	GIT_COMMITTER_NAME	本版本最新提交者名称	✅	✅	✅
12	GIT_AUTHOR_NAME	本版本最新提交作者名称	✅	✅	✅
13	REF	要构建的版本	✅	✅	✅
14	GIT_PREVIOUS_SUCCESSFUL_COMMIT	前一个构建运行成功的修订版本号	✅	✅	✅
15	GIT_COMMITTER_EMAIL	本版本最新提交者名称	✅	✅	✅
16	GIT_BRANCH	触发构建的分支	✅	✅	✅
17	GIT_URL	仓库 SSH 协议地址	✅	✅	✅
18	GIT_LOCAL_BRANCH/BRANCH_NAME	本地分支名称	✅	✅	✅
19	FETCH_REF_SPECS	git 要检出的 refs	✅	✅	✅
20	GIT_REPO_URL	仓库 SSH 地址	✅	✅	✅
21	JOB_ID	构建计划 id	✅	✅	✅
22	JOB_NAME	构建计划名称	✅	✅	✅
23	CI_BUILD_NUMBER	构建编号	✅	✅	✅
24	PROJECT_ID	项目 ID	✅	✅	✅
25	PROJECT_NAME	项目名称	✅	✅	✅
26	PROJECT_WEB_URL	项目网页地址	✅	✅	✅
27	PROJECT_API_URL	项目后端 api 地址	✅	✅	✅
28	PROJECT_TOKEN	项目令牌密码用于读取项目	✅	✅	✅
29	PROJECT_TOKEN_GK	项目令牌用户名	✅	✅	✅
30	GIT_TAG	触发构建的 Git 标签 (仅在使用标签构建的时候才会有)	✅
31	DEPOT_NAME	当前使用的代码仓库名称	✅
32	CCI_CURRENT_PROJECT_COMMON_CREDENTIALS_ID (即将上线)	内置项目令牌的 CredentialsId	✅
33	CCI_CURRENT_TEAM （即将上线）	当前构建环境的企业名，如: myteam.coding.net 中的 myteam	✅
34	CCI_CURRENT_DOMAIN （即将上线）	当前构建环境的域名，如: myteam.coding.net 中的 coding.net	✅
35	MR_RESOURCE_ID	合并请求 ID			✅
36	MR_TARGET_BRANCH	合并请求目标分支名			✅
37	MR_TARGET_SHA	合并请求目标分支版本号			✅
38	MR_MERGED_SHA	模拟合并完的版本号			✅
39	MR_SOURCE_BRANCH	合并请求源分支名			✅
40	MR_STATUS	合并请求状态			✅
41	MR_SOURCE_SHA	合并请求源分支版本号			✅

问题反馈 >

2023-02-21最近更新

感谢反馈有用

感谢反馈没用