- 最新动态
- 功能总览
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 模板管理
-
流水线管理
- 启动流水线
- 批量获取流水线状态
- 获取流水线状态/获取流水线执行详情
- 获取流水线列表/获取项目下流水线执行状况
- 删除流水线
- 查询流水线详情
- 修改流水线信息
- 停止流水线
- 获取流水线执行记录
- 基于模板创建流水线
- 创建流水线
- 重试运行流水线
- 通过人工审核
- 获取流水线运行需要的自定义参数
- 驳回人工审核
- 查询流水线日志
- 获取流水线步骤执行输出
- 查询流水线上的构建产物
- 批量删除流水线
- 禁用流水线
- 批量设置流水线标签
- 启用流水线
- 批量运行流水线
- 查询流水线任务日志
- 延时任务通过
- 延时任务拒绝
- 延时1小时
- 手动卡点通过
- 手动卡点拒绝
- 解除挂起
- 查询批量执行流水线结果
- 交换分组顺序
- 流水线官方消息通知查询
- 流水线官方消息通知更新
- 流水线消息通知开关
- 流水线第三方消息通知查询
- 流水线第三方消息通知更新
- 查询流水线的角色权限
- 查询流水线的用户权限
- 修改流水线的角色权限
- 修改流水线的用户权限
- 查询流水线是否启用二级权限
- 修改流水线是否启用二级权限
- 批量设置流水线实例二级权限
- 取消某次流水线排队
- 查询当前流水线排队中的记录
- 查询流水线的旧版运行记录
- 查询流水线运行使用的参数
- 回退执行流水线
- 获取step跳转链接
- 查询流水线运行的变更
- 查询流水线可用的系统参数
- 查询流水线触发失败记录
- 查询流水线修改历史
- 创建参数组
- 修改参数组
- 删除参数组
- 流水线绑定参数组
- 查询参数组详情
- 查询流水线关联的参数组
- 查询参数组列表
- 获取通用Webhook信息
- 分组管理
- 规则管理
- 租户级策略管理
- 项目级策略管理
- 扩展插件管理
- 扩展点管理
- 标签管理
- 变更管理
- 微服务管理
- 模板管理(旧版,待下线)
- 流水线管理(旧版,待下线)
- 应用示例
- 附录
- 文档修订记录
- 场景代码示例
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
配置流水线参数
流水线参数可以传递给各个任务使用,实现任务间数据流动的统一,只需要配置好流水线参数,即可完成构建、部署、接口测试等任务的数据拉通。流水线参数包括以下三种。
- 系统预定义参数:系统默认提供的参数,无需定义、不能删除、不能修改。
- 自定义参数:根据需要自定义添加,参数类型包括字符串类型、枚举类型、自增长类型。
- 通用参数组:项目下通用流水线参数,所有流水线都可以关联并使用通用参数组。
- 新建流水线时如果设置了别名,可基于别名生成仓库对应的系统参数,未设置别名则以仓库名作为别名,生成系统参数,如:“别名_TAG”,表示仓库标签名称。
- 当同一条流水线关联多个参数组,且多个参数组存在同名参数时,以后关联的参数组参数取值为准。
- 参数引用形式:${参数名},在参数输入框输入“$”符号后会自动出现参数列表。
流水线系统预定义参数
参数信息 |
说明 |
---|---|
PROJECT_ID |
当前流水线所属项目ID。 |
PIPELINE_ID |
当前流水线ID。 |
PIPELINE_NUMBER |
流水线执行编号。 |
COMMIT_ID |
执行时代码最后一次提交的ID。 |
COMMIT_ID_SHORT |
执行时代码最后一次提交的短ID。 |
TIMESTAMP |
流水线执行时间戳。例如:20211222124301。 |
PIPELINE_TRIGGER_TYPE |
流水线触发类型。包括:Manual、Scheduler、RollBack以及WebHook类型(CreateTag、Note、Issue、MR、Push)。 |
PIPELINE_NAME |
流水线名称。 |
REPO_URL |
代码仓地址(HTTPS)。 |
EXECUTE_USER |
执行人。 |
EXECUTE_USER_ID |
执行人ID。 |
EXECUTE_USER_NAME |
执行人名称。 |
EXECUTE_USER_NICKNAME |
执行人昵称。 |
PASS_CONDITIONS_LINK |
流水线执行详情链接。 |
PIPELINE_RUN_ID |
流水线执行ID。 |
MERGE_ID |
合并请求ID。 |
WEBHOOK_PAYLOAD |
Webhook请求负载信息。 |
Repo01_REPOSITORY_NAME |
仓库名称。 |
Repo01_SOURCE_BRANCH |
仓库运行源分支名称。 |
Repo01_TARGET_BRANCH |
仓库运行目标分支名称。 |
Repo01_TAG |
仓库标签名称。 |
Repo01_COMMIT_ID |
执行时代码最后一次提交的ID。 |
Repo01_COMMIT_ID_SHORT |
执行时代码最后一次提交的短ID |
Repo01_REPO_URL |
代码仓地址(HTTPS)。 |
配置流水线自定义参数
介绍流水线自定义参数新建和配置。
- 访问CodeArts Pipeline首页。
- 在流水线列表页搜索目标流水线,单击操作列,选择“编辑”。
- 进入流水线“任务编排”页面,切换至“参数设置”页面。
- 单击参数列表下的“立即新建”(已存在自定义参数,则单击“新建参数”),填写参数信息。
表2 流水线自定义参数说明 参数信息
说明
名称
自定义参数名称。支持大小写英文字母、数字、“_”,长度不超过128个字符。
说明:自定义参数名称不可与系统预定义参数名称相同。
类型
参数可选类型:字符串(默认类型)、自增长、枚举。
默认值
自定义参数的默认取值。
私密参数
参数为私密参数时,系统会将输入参数做加密存储,使用时解密,同时在运行日志里不可见。
运行时设置
打开“运行时设置”开关,在执行流水线时支持修改该参数的值。
参数描述
不超过512个字符。
说明:- 最多可以新建100个自定义参数。
- 单击“操作”列,可以新增参数;单击“操作”列,可以删除参数。
- 配置完成后,保存流水线。
配置流水线通用参数组
- 通过项目入口方式访问CodeArts Pipeline首页。
- 切换至“通用参数组”页面,单击“新建参数组”。
- 进入“新建通用参数组”页面,填写参数信息。
图1 新建通用参数组
表3 通用参数组参数说明 基本信息
说明
所属项目
通用参数组归属项目,不可更改。
参数组名称
支持大小写英文字母、数字、“_”,长度不超过128个字符。
描述
长度不超过512个字符。
自定义参数列表
单击“立即新建”,可根据需要添加自定义参数,参数配置方法同自定义参数。
说明:最多可以新建5个通用参数组,每个参数组最多可以添加20个自定义参数。
- 单击“确定”,新建完成。
- 编辑需要关联通用参数组的流水线,进入“参数设置 > 通用参数组”页面。
- 单击“立即关联”,选择参数组,然后单击“确定”,即可将参数组关联到当前流水线。
- 展开通用参数组,可以查看参数详情。
- 单击操作列,可以解除关联参数组。
图2 关联参数组
- 配置完成后,保存流水线。
流水线参数应用示例
本文以通过流水线统一配置releaseversion参数并传递到构建任务为例,介绍流水线参数使用方法。
- 新建构建任务。
- 在“参数设置”页面添加releaseversion参数并设置好默认值,打开“运行时设置”。
图3 新建构建任务参数
- 在“构建步骤”页面,选择“上传软件包到软件发布库”,将“发布版本号”配置成引用参数形式。在参数输入框输入“$”符号后会自动出现参数列表,选择上一步已经新建好的releaseversion参数。
图4 引用构建任务参数
说明:使用“$”符号引用通用参数组的参数时不会自动生成提示。
- 配置完成后,保存构建任务。
- 新建空白模板流水线,在流水线阶段添加一个新的任务,然后在该任务中添加“Build构建”插件并调用刚创建的构建任务,即可看到刚新建好的构建任务参数releaseversion。
图5 配置构建任务参数
- 将鼠标移动到releaseversion参数上,可以一键将该参数设置为流水线参数并能直接引用该参数;或直接单击“确定”,然后切换到流水线“参数设置”页面,新建流水线参数releaseversion,类型可以根据需求选择自增长或字符串等,设置默认值并打开运行时设置。
图6 新建流水线参数
- 再切回到流水线“任务编排”页面,编辑刚添加的构建任务,将流水线的releaseversion参数通过“$”符号引用到构建任务的releaseversion参数内。
图7 引用流水线参数
说明:- 该处只显示构建任务中开启“运行时设置”的文本类型参数。
- 鼠标移至参数名称,可以快速将该参数设置为流水线参数并能直接引用该参数。
- 完成参数引用后,保存信息,然后单击“保存并执行”,弹出“执行配置”对话框,可查看“运行参数配置”。
运行时参数值默认为添加参数时为参数设置的默认值,可根据需要进行修改。流水线运行时在构建任务内使用的就是此时输入的参数值。
- 设置完参数,单击“执行”,开始使用配置的参数执行流水线。