流水线上下文

更新时间：2024-12-27 GMT+08:00

流水线上下文存储了流水线运行的实例、变量、任务等信息，每个上下文都是一个包含各种属性的对象。流水线上下文主要包括以下四类：

表1 流水线上下文
上下文	类型	说明
pipeline	object	流水线运行相关的信息。
sources	object	流水线运行的源相关的信息。
env	object	流水线运行的自定义参数相关的信息。
jobs	object	流水线运行的已执行完成的任务相关的信息。

流水线上下文引用形式

${{ <context>.<attribute_name> }}

其中，context表示流水线上下文，attribute_name表示属性。

流水线上下文属性介绍

表2 流水线上下文属性
上下文	属性	类型	说明	示例
pipeline context	pipeline	object	流水线运行相关的所有信息，此对象包含的属性包括：project_id、pipeline_id、run_number、timestamp、trigger_type和run_id。	内容示例如下示例为一次手动运行的流水线包含的pipeline context信息。 { "project_id": "6428c2e2b4b64affa14ec80896695c49", "pipeline_id": "f9981060660249a3856f46c2c402f244", "run_number": "168", "timestamp": "20231016000004", "trigger_type": "Manual", "run_id": "c2f507f93510459190b543e47f6c9bec" } 使用示例如需在某个任务的输入中获取本次流水线运行的触发方式，可使用如下语法来获取。 ${{ pipeline.trigger_type }}
	pipeline.project_id	string	当前流水线所属项目ID，同现有流水线系统预定义参数PROJECT_ID。
	pipeline.pipeline_id	string	当前流水线ID，同现有流水线系统预定义参数PIPELINE_ID。
	pipeline.run_number	string	流水线执行编号，同现有流水线系统预定义参数PIPELINE_NUMBER。
	pipeline.timestamp	string	流水线执行时间戳，同现有流水线系统预定义参数TIMESTAMP，格式为yyyyMMddHHmmss。如：20211222124301。
	pipeline.trigger_type	string	流水线触发类型，同现有流水线系统预定义参数PIPELINE_TRIGGER_TYPE。
	pipeline.run_id	string	流水线执行ID，同现有流水线系统预定义参数PIPELINE_RUN_ID。
sources context	sources	object	流水线运行的源相关的所有信息，此对象包含的属性包括：alias、repo_name、commit_id、commit_id_short、commit_message、repo_url、repo_type、repo_name、ssh_repo_url、tag、merge_id、source_branch和target_branch。	内容示例如下示例为单代码源的流水线一次手动运行所包含的sources context信息，其中代码源别名为“my_repo”。 { "my_repo": { "commit_id": "dedb73bb9abfdaab7d810f2616bae9d2b6632ecc", "commit_id_short": "dedb73bb", "commit_message": "maven0529 更新 pipeline0615.yml", "repo_url": "https://example.com/clsyz00001/maven0529.git", "repo_type": "codehub", "repo_name": "maven0529", "ssh_repo_url": "git@example.com:clsyz00001/maven0529.git", "target_branch": "master" } } 使用示例如需在某个任务的输入中获取本次流水线运行的运行分支，可使用如下语法来获取。 ${{ sources.my_repo.target_branch }}
	sources.<alias>	object	别名为alias对应的流水线源的所有信息，当流水线源定义别名时存在。
	sources.<repo_name>	object	代码仓名称为repo_name的流水线代码源的所有信息，当代码源未定义别名时存在，包含属性同alias。
	sources.<alias>.commit_id	string	流水线执行前最后一次代码提交的CommitID，同现有流水线系统预定义参数COMMIT_ID。
	sources.<alias>.commit_id_short	string	流水线执行前最后一次代码提交的CommitID的前8位，同现有流水线系统预定义参数COMMIT_ID_SHORT。
	sources.<alias>.commit_message	string	流水线执行前最后一次代码提交的提交信息。
	sources.<alias>.repo_url	string	代码仓地址（HTTPS），同现有流水线系统预定义参数REPO_URL。
	sources.<alias>.repo_type	string	代码仓类型。如：codehub、gitlab、github、gitee、general_git。
	sources.<alias>.repo_name	string	代码仓名称。
	sources.<alias>.ssh_repo_url	string	代码仓地址（SSH）。
	sources.<alias>.tag	string	标签触发时的标签名称。
	sources.<alias>.merge_id	string	合并请求触发时的合并请求ID。
	sources.<alias>.source_branch	string	合并请求触发时的源分支名称。
	sources.<alias>.target_branch	string	MR时代表目标分支名称，否则代表运行分支名称。
env context	name	string	自定义参数名称。	内容示例如下示例为流水线一次运行包含的env context信息，包含了两个自定义参数。 { "var_1": "val1", "var_2": "val2" } 使用示例如需要在某个任务的输入中获取本次流水线运行的自定义参数“var_1”的值，可使用如下语法来获取。 ${{ env.var_1 }}
env context	value	string	自定义参数值。
jobs context	jobs	object	流水线运行的任务相关的信息，此对象包含的属性包括： job_id、status、outputs、output_name、metrics、metric_name。	内容示例如下示例为流水线一次运行对应的jobs context信息，包含两个执行成功的任务，ID为“check_job”的任务的输出为两项指标，ID为“demo_job”的任务的输出为两项一般输出。 { "check_job": { "status": "COMPLETED", "metrics": { "critical": "0", "major": "0" } }, "demo_job": { "status": "COMPLETED", "outputs": { "output1": "val1", "output2": "val2" } } } 使用示例如需要在后续任务的输入中获取本次运行的“demo_job”的输出“output1”的值，可使用如下语法来获取。 ${{ jobs.demo_job.outputs.output1 }}
	jobs.<job_id>	object	ID为job_id的任务包含的所有信息。
	jobs.<job_id>.status	string	任务的运行结果，取值结果为：INIT（初始化）、QUEUED（排队中）、RUNNING（运行中）、CANCELED（已中止）、COMPLETED（成功）、FAILED（失败）、PAUSED（暂停）、IGNORED（忽略）、SUSPEND（挂起）或UNSELECTED（未选择）。
	jobs.<job_id>.outputs	object	任务的运行一般输出，即键值对形式的数据输出。
	jobs.<job_id>.outputs.<output_name>	string	任务的运行一般输出的数据名称。
	jobs.<job_id>.metrics	object	任务的运行指标输出。如：代码检查问题数、测试通过率等指标项。
	jobs.<job_id>.metrics.<metric_name>	string	任务的运行指标输出的名称。

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

流水线上下文

流水线上下文引用形式

流水线上下文属性介绍

相关信息

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈