流水线参数使用

流水线

流水线(CodeArts Pipeline)提供可视化、可编排的CI/CD持续交付软件生产线,帮助企业快速转型,实现DevOps持续交付高效自动化,缩短应用TTM(Time to Market)交付周期,提升研发效率

参数介绍

流水线参数可以传递给各个任务使用(通过“${参数名}”方式引用),实现任务间数据流动的统一,用户只需要配置好流水线参数,即可完成构建、部署、接口测试等任务的数据拉通。流水线参数包括以下两种。

1、自定义参数:根据需要自定义添加,参数类型包括:字符串类型、枚举类型、自增长类型和主机组类型。

2、系统预定义参数:系统默认提供的参数,无需定义,不能删除,不能修改。包括:PROJECT_ID、PIPELINE_ID、PIPELINE_NUMBER、COMMIT_ID、TIMESTAMP。

参数使用

以通过流水线统一配置releaseversion参数并传递到构建任务为例,介绍流水线参数使用方法,其他任务操作方法相同。

一、新建构建任务。

二、在“参数设置”页面添加releaseversion参数并设置好默认值,将“运行时设置”打开。

三、在“构建步骤”页面,选择“上传软件包到软件发布库”,将“发布版本号”配置成引用参数形式。在参数输入框输入“$”符号后会自动出现参数列表,选择上一步已经新建好的releaseversion参数。

四、配置完成后,保存构建任务。

五、新建空白模板流水线,在流水线阶段添加一个新的任务,然后在该任务中添加“CodeArtsBuild构建”插件并调用刚创建的构建任务,即可看到刚新建好的构建任务参数releaseversion。

六、将鼠标移动到releaseversion参数上,可以一键将该参数设置为流水线参数。或直接单击“确定”,然后切换到流水线“参数设置”页面,新建流水线参数releaseversion,类型可以根据需求选择自增长或字符串等,设置默认值并打开运行时设置。

七、再切回到流水线“任务编排”页面,编辑刚添加的构建任务,将流水线的releaseversion参数通过“$”符号引用到构建任务的releaseversion参数内。

说明:

  1. 该处只显示任务中已开启“运行时设置”的文本类型参数。
  2. 参数引用形式为“${ParameterName}”,其中“ParameterName”为流水线参数名,在参数输入框输入“$”符号后会自动出现参数列表。
  3. 鼠标移至参数名称,可以快速将该参数设置为流水线参数并能直接引用该参数。

八、完成参数引用后,保存信息,然后单击“保存并运行”,弹出“运行配置”侧滑框,可查看“运行参数配置”。

运行时参数值默认为添加参数时为参数设置的默认值,可根据需要进行修改。流水线运行时在构建任务内使用的就是此时输入的参数值。

九、设置完参数,单击“保存”,然后单击“执行”,开始使用配置的参数执行流水线。


流水线参数相关问题

代码检查常见问题

  • 任务中引用的流水线参数不存在

    背景信息

    流水线参数可以通过“${参数名}”形式传递给各个任务使用,如果流水线上某个任务使用“${参数名}”关联的参数不在流水线参数列表中,会提示参数不存在。


    问题现象

    编辑流水线后单击“保存”时,界面右上角弹出如下通知。


    原因分析

    1、单击报错的任务名,进入任务配置页面,查看任务参数配置。

    2、进入流水线“参数设置”页面,查看流水线参数配置。

    可以看到,任务参数中引用的“releaseversion”参数在流水线参数列表中没有配置,因此会报此异常。


    处理方法

    可使用以下两种方法将被引用的参数(如:releaseversion)添加到流水线参数列表中。

    1、在流水线“参数设置”页面,单击“立即创建”即可添加参数。

    2、单击报错的任务名,在任务配置页面,将鼠标移至releaseversion旁,单击“设置为流水线参数”一键添加参数。

流水线精选推荐