新建构建任务
前提准备
(该操作仅使用代码化构建时执行)
编写YAML文件,并存放在代码仓库的“.cloudbuild”目录下。YAML文件编写方法可参考单任务YAML文件结构说明。
若YAML文件不存放在“.cloudbuild”目录,可通过“CB_BUILD_YAML_PATH”参数来指定YAML文件在代码仓中的路径。参数配置可参考配置构建任务参数 (可选操作)。
配置基本信息
- 参考需求管理CodeArts Req服务的,新建项目。
- 参考代码托管CodeArts Repo服务的,新建代码仓库。
- 登录编译构建服务首页。
- 单击“新建任务”,进入配置“基本信息”页面,填写构建任务基本信息。使用图形化构建,参考表1;使用代码化构建,参考表2。
表1 图形化构建基本信息配置说明 参数项
描述
名称
任务的名称。
归属项目
任务所属项目。
代码源
- Repo:从拉取代码进行构建。
- 来自流水线:如果选择来自,则只能通过流水线任务驱动执行,不能单独执行。
以下为第三方代码仓库,首次使用第三方代码仓,需新建服务扩展点,详情可参考新建服务扩展点(可选操作)。
- 通用Git:拉取托管在其他服务上的代码进行构建。
代码仓
选择实际使用的代码仓。
默认分支
选择仓库默认分支。
任务描述
对任务进行描述。
配置构建模板
- 单击“下一步”,进入“构建模板”页面。
- 选择构建模板。
- 图形化构建:选择适合自己项目的构建模板。
也可以选择“空白构建模板”,然后添加实际使用的构建步骤。如果预置模板不满足使用要求,也可以自定义模板。
- 代码化构建:选择“空白构建模板”。
使用代码化构建时,选择任何构建模板都不影响使用YAML构建。
- 图形化构建:选择适合自己项目的构建模板。
配置构建任务参数 (可选操作)
编译构建服务默认生成codeBranch参数和系统预定义参数。用户可以根据需要修改codeBranch参数类型和参数值,并添加其他自定义参数。
系统预定义参数的参数值由系统自动生成,无需定义,可通过${参数名}引用。
配置指导如下:
- 切至“参数设置”页签,单击“新建参数”。
- 新建字符串类型参数:“类型”选择“字符串”,根据实际需要修改参数名、参数类型、参数值,以及是否设置为私密参数或者运行时设置。
- 新建枚举类型参数:填写参数名称,“类型”选择“枚举”,在弹出的对话框中,填写“可选取值”,每个参数值必须以英文分号结尾。设置完后,在“默认值”列单击下拉列表,为该参数设置一个默认值。
- 新建自增长类型参数:“类型”选择“自增长”,在“默认值”列设置参数。
- 使用参数示例如下。
- 使用自定义参数
- 系统预定义参数
- 配置执行参数。 编辑构建任务,选择“构建步骤”页签,配置构建步骤,在发布版本号文本框里输入“${BUILDNUMBER}”,保存构建任务。
参数名
说明
BUILDNUMBER
构建编号。格式为“日期.今日该构建任务执行次数”,例如:20200312.3。
TIMESTAMP
构建执行时间戳。例如:20190219191621。
INCREASENUM
该任务构建执行总次数,从1开始自增长,每执行1次加1。
PROJECT_ID
项目编号。
WORKSPACE
工作空间,源代码根目录。
GIT_TAG
代码tag名,使用tag构建时才有值。
COMMIT_ID_SHORTER
代码提交号的前8位。
COMMIT_ID
代码提交号。例如:b6192120acc67074990127864d3fecaf259b20f5。
- 执行构建任务。
- 本构建任务是Maven构建并且开通了制品仓库服务,所以可以在软件发布库里查到该任务的构建包。
- 配置执行参数。
配置构建任务执行计划(可选操作)
编译构建支持用户配置触发事件和定时执行任务,从而使得开发者达到项目持续集成的目的。
切换至“执行计划”页签,根据实际需要配置执行计划。
- 持续集成:将“提交代码触发执行”按钮设置为开启状态,构建任务所引用的代码源发生提交代码行为时,则会触发执行构建任务。
代码源为“Repo”时才能使用。
- 定时执行:将“启用定时执行”按钮设置为开启状态,选择需要构建任务定时执行的时间,并可按需开启是否“代码变化才执行”。
功能开启后,构建任务会按照您设定的执行日与时间定时执行。
若同时开启了“代码变化才执行”按钮,只有到达设定的执行日和时间,并且代码与上次构建有所变动时才会执行构建任务。
配置构建任务角色权限(可选操作)
编译构建支持为当前构建任务的各个角色配置权限,默认的用户角色类型及对构建任务的操作权限说明参考表3。
| 项目角色 | 编辑 | 删除 | 查看 | 执行 | 复制 | 禁用 | 权限管理 |
|---|---|---|---|---|---|---|---|
| 任务创建者 | √(*) | √(*) | √(*) | √(*) | √(*) | √(*) | √(*) |
| 项目创建者 | √(*) | √(*) | √(*) | √(*) | √(*) | √(*) | √(*) |
| 项目经理 | √ | √ | √ | √ | √ | √ | √ |
| 开发人员 | √ | √ | √ | √ | √ | √ | × |
| 测试经理 | × | × | √ | × | × | × | × |
| 测试人员 | × | × | × | × | × | × | × |
| 参与者 | × | × | × | × | × | × | × |
| 浏览者 | × | × | √ | × | × | × | × |
- “√”表示默认有权限,“×”表示默认没有权限。
- 拥有“权限管理”权限的角色可以修改权限矩阵,但带“*”的权限不可修改。
- 项目创建者、项目经理和开发人员可以创建编译构建任务。
切换至“权限管理”页签,可根据实际需要配置不同角色的操作权限。
单击“同步项目权限”,可将当前构建任务的权限同步为项目权限。项目权限配置详情请参考配置项目级角色权限。
配置构建任务事件通知(可选操作)
编译构建支持给用户发送事件通知。任务构建成功、任务构建失败、任务被禁用、任务配置被更新和任务被删除时,可以给用户发送消息通知、邮件通知。
切换至“通知”页签,按照实际需要进行配置。
- 配置消息/邮件通知:分别选择“消息”通知和“邮件”通知进行设置。
默认所有事件都发送消息通知,构建任务失败发送邮件通知,请根据实际需要设置开关状态。
- 配置钉钉通知:
- 进入钉钉群,找到“群设置 > 智能群助手”,然后添加机器人(选择自定义类型)。
- 填写机器人名字,选择群组,完成安全设置(需勾选“加签”,并单击加签文本框旁的“复制”获取加签密钥)。
- 已阅读并同意相关协议后,单击“完成”。单击Webhook文本框旁的“复制”获取钉钉Webhook地址。
- 选择“钉钉”通知,填写Webhook地址并单击“测试”确保Webhook地址可用。
- 勾选“启动加签密钥”并填写加签密钥、选择事件类型。
- 单击“保存”。
配置完成后,当任务运行结果满足事件类型时,编译构建服务会发送消息到指定的钉钉群。
自定义构建任务模板(可选操作)
如果需将当前的构建任务保存为模板,以便后续创建构建任务时选择,则可以按照以下操作执行。
- 在构建任务历史页面,单击页面右上角
,在下拉列表中选择“保存模板”。 - 在弹框中输入模板名称与模板描述,单击“保存”。
- 单击用户名,在下拉菜单中选择。
- 选择导航栏,即可在列表中看到已保存的构建模板。
对已保存的构建模板,可以完成以下操作:
表4 管理自定义模板 操作
说明
搜索模板
在搜索框输入关键字,可搜索模板。
收藏模板
单击
,可以收藏该模板。删除模板
单击
,在弹框中单击“确定”,即可删除该模板。
新建服务扩展点(可选操作)
当在配置基本信息阶段,代码源选择第三仓库时需要配置。
服务扩展点(Endpoint)是软件开发生产线的一种扩展插件,为软件开发生产线提供链接第三方服务的能力。
编译构建服务默认从代码托管服务拉取代码进行构建,同时也可使用服务扩展点连接第三方代码仓库获取项目源码。
- 使用第三方代码仓库可能出现网络不稳定或其他问题,具体使用体验取决于第三方代码仓库网络环境和服务状态。
- 建议使用代码托管的代码导入功能,将代码导入到代码托管,实现安全、稳定、高效下载与构建。
新建通用Git服务扩展点
- 单击“扩展点实例”右侧的“新建”。
- 在弹出的对话框中,配置如下参数。
参数名称
功能描述
连接名称
服务扩展点的名称,可自定义。
Git仓库Url
Git仓库的Url(https协议地址)。
用户名
Git仓库用户名。
密码或Access Token
Git仓库密码或Access Token。
- 单击“确定”。