更新时间:2024-10-11 GMT+08:00

配置构建任务参数

编译构建服务默认生成codeBranch参数和系统预定义参数。用户可以根据需要修改codeBranch参数类型和参数值,并添加其他自定义参数。

系统预定义参数

系统预定义参数的参数值由系统自动生成,无需定义,如表1所示,可在代码中使用${参数名}引用。

表1 系统预定义参数

参数

说明

BUILDNUMBER

构建编号。格式为“日期.今日该构建任务执行次数”,例如:20200312.3。

TIMESTAMP

构建任务执行时间戳。例如:20190219191621。

INCREASENUM

该构建任务执行总次数,从1开始自增长,每执行1次加1。

PROJECT_ID

该构建任务所在的项目编号。

WORKSPACE

该构建任务拉取的源代码根目录,即工作空间。

GIT_TAG

代码tag名,在配置代码下载时指定tag构建才有值。

COMMIT_ID_SHORTER

代码提交号的前8位。在配置代码下载时指定CommitID构建才有值。

COMMIT_ID

代码提交号。例如:b6192120acc67074990127864d3fecaf259b20f5。

添加自定义参数的配置指导

在编译构建任务配置页面,切换至“参数设置”页签,单击“新建参数”,参考表2配置参数。

表2 添加自定义参数

名称

类型

默认值

私密参数

运行时设置

参数描述

自定义参数名称。支持字母,数字,下划线“_”,长度不超过128个字符。

说明:
  • 以下字段不可用:LD_PRELOAD、LD_LIBRARY_PATH、PATH、BASH_ENV、GIT_SSH_COMMAND。
  • 不可使用以下符号“{{”“{%”“{#”

字符串

自定义参数的默认值。长度不超过8192个字符。

设置是否为私密参数。参数为私密参数时,系统会将输入参数进行加密存储,使用时再进行解密,同时在运行日志里不可见。

设置该参数是否在执行构建任务时设置。

打开“运行时设置”开关,表示通过单击按钮执行构建任务时支持变更参数值,并且系统会把该参数上报到流水线服务。

自定义关于该参数的描述信息。长度不超过1024个字符。

枚举

在弹出的对话框中,填写自定义的“可选取值”,每个参数值必须以英文分号结尾。长度不超过8192个字符。

配置完可选取值后,在“默认值”的下拉框中为该参数配置一个默认值。

自增长

自定义参数的默认值。长度不超过8192个字符。

使用参数的操作指导

图1为例为您介绍如何使用自定义的参数。

图1 自定义参数
  1. 在编译构建任务配置页面切换到“构建步骤”页签,在“上传软件包至软件发布库”构建步骤的“发布版本号”中输入“${myparam}”,保存并执行构建任务。
  2. 在弹框中,将“myparam”修改为“1.0.1.2”,单击“确定”,等待构建任务执行完成。
    图2 填写运行参数值
  3. 进入软件发布库,找到刚构建的构建包,即可看到版本号就是修改后的的“myparam”值。
    图3 查看构建包