配置构建参数

参数配置

1. 登录编译构建服务首页。
2. 在编译构建任务列表搜索目标任务。
3. 单击编译构建任务所在行，在下拉列表中选择“编辑”，进入“编辑任务”页面。
4. 切至“参数设置”页签。

   

   参数信息说明如下：

   基本信息	说明
   名称	参数名称。除系统默认生成的codeBranch参数和系统预定义参数，其余自定义新增的参数可自定义修改参数名称。
   类型	参数可选类型。包括字符串类型、枚举类型和自增长类型。
   默认值	参数的默认值。选择不同类型的参数系统都会自动生成对应的默认值，可根据需要修改参数值。
   私密参数	参数为私密参数时，系统会将输入参数做加密存储，使用时进行解密，同时在运行日志里不可见。
   运行时设置	打开表示单独执行构建任务时支持变更参数值，并且也会把该参数上报流水线。运行时参数需要执行时输入。
   参数描述	对该参数的详情描述
   操作	可单击，删除该参数。

   • 添加字符串类型参数

     单击“新建参数”，默认新增一条字符串类型参数，可根据需要修改参数名、参数类型、参数值，以及是否设置为私密参数或者运行时设置。

   • 添加枚举类型参数
     1. 单击“新建参数”。
     2. 单击参数类型旁的，在下拉列表选择“枚举”，弹出“枚举参数”对话框。
     3. 为参数设置“可选取值”，每个参数值必须以英文分号结尾。
     4. 设置完成后，在“默认值”列单击下拉列表，选择其中一个值。
   • 添加自增长类型参数
     1. 单击“新建参数”。
     2. 单击参数类型旁的，在下拉列表选择“自增长”。
     3. 在“默认值”列设置参数。

参数使用

分别举例介绍自定义参数和系统预定义参数的使用。

在使用yaml构建时，需注意参数使用的优先级：

运行时参数 > 构建任务参数设置里配置的参数 > BuildFlow子任务yaml文件中定义的参数 > BuildFlow父任务yaml文件中Job上定义的参数 > BuildFlow父任务yaml文件中定义的全局参数。

• 自定义参数
  1. 配置执行参数。

     编辑构建任务，选择“参数设置”页签，添加一条参数，设置参数名称和参数值（本例参数名设置为“myparam”、默认值设置为“1.0.1.1”），打开“运行时设置”。

  2. 使用执行参数。

     切换到“构建步骤”页签，配置构建步骤，在发布版本号文本框里输入“${myparam}”,保存构建任务。

  3. 执行构建任务。

     弹出“设定参数并执行”框，根据实际情况输入值或者使用默认值。

  4. 本构建任务是Maven构建并且开通了制品仓库服务，所以可以在制品仓库服务里查到该任务的构建包。

     进入软件发布库，找到刚构建的构建包，即可看到版本号就是用户自定义的执行参数“myparam”值。

• 系统预定义参数
  1. 配置执行参数。
     编辑构建任务，选择“构建步骤”页签，配置构建步骤，在发布版本号文本框里输入“${BUILDNUMBER}”，保存构建任务。

     参数名	说明
     BUILDNUMBER	构建编号。格式为“日期.今日该构建任务执行次数”，例如：20200312.3。
     GIT_COMMIT	代码提交号。例如：b6192120acc67074990127864d3fecaf259b20f5。
     TIMESTAMP	构建执行时间戳。例如：20190219191621。
     INCREASENUM	该任务构建执行总次数，从1开始自增长，每执行1次加1。
     PROJECT_ID	项目编号。
     WORKSPACE	工作空间，源代码根目录。
     GIT_TAG	代码tag名，使用tag构建时才有值。

  2. 运行构建任务。
  3. 本构建任务是Maven构建并且开通了制品仓库服务，所以可以在软件发布库里查到该任务的构建包。

     进入软件发布库，找到刚构建的构建包，即可看到版本号就是系统的执行参数“BUILDNUMBER”的值。