更新时间:2025-05-21 GMT+08:00
分享

新建代码化构建任务

代码化构建是指通过YAML文件配置构建脚本,将构建过程需要用到的构建环境、构建参数、构建命令、构建工具等信息通过YAML语法编写成“build.yml”文件,并且将“build.yml”文件随着被构建的代码一起存储代码仓库,执行构建任务时,系统会以“build.yml”文件作为构建脚本执行构建任务。

代码化构建功能优势如下:

  • 清晰描述构建过程:构建参数、构建命令、构建步骤、以及构建后的操作,使构建过程可信。
  • 每次构建使用对应当前commit的“build.yml”配置,保证构建可还原可追溯,不必担心因修改了构建配置而不能重复执行之前的任务。
  • 如果新特性需要修改构建脚本,开发人员可以拉一个新的分支修改“build.yml”去测试,而不用担心影响其他分支。

约束与限制

代码化构建仅支持使用CodeArts Repo代码仓。

新建构建任务前准备工作

  • 已具备CodeArts Repo服务的操作权限。
  • 已参考代码托管服务(CodeArts Repo)的用户指南 > 创建 > 代码托管仓库,新建代码仓库。
  • 参考软件开发生产线(CodeArts)的用户指南 > 软件开发生产线(CodeArts)使用前准备 > 新建CodeArts项目新建CodeArts项目

    如果已有项目,无需执行此步骤。

创建代码化构建使用的YAML文件

  1. 通过项目入口方式访问CodeArts Build服务首页
  2. 选择导航栏代码 > 代码托管,进入代码托管页面。
  3. 单击“新建仓库”,选择“普通仓库”,单击“下一步”,根据表1填写参数后,单击“确定”
    表1 新建代码仓

    参数

    说明

    代码仓库名称

    自定义代码仓名称。例如:maven_yml_build。

    • 以数字、字母或者“_”开头。
    • 可包含“.”“-”
    • 不能以“.git”“.atom”或者“.”结尾。

    描述

    可选参数。对代码仓的描述。

    选择gitignore

    可选参数。根据编程语言选择“.gitignore”,例如:Java。

    初始化设置

    勾选全部。

    • 允许项目内人员访问仓库:选择后会自动将项目中的项目经理设为仓库管理员,开发人员设为仓库普通成员。当项目新增这两个角色时,也会自动同步到已经存在的仓库中。
    • 允许生成README文件:可以通过编辑README文件,记录项目的架构、编写目的等信息,相当于对整个仓库的一种注释。
    • 自动创建代码检查任务(免费):仓库创建完成后在代码检查任务列表中,可看到对应仓库的检查任务。

    可见范围

    设置为“私有”

    • 私有:仓库仅对仓库成员可见,仓库成员可访问仓库或者提交代码。
    • 公开只读:仓库对所有访客公开只读,但不出现在访客的仓库列表及搜索中,您可以选择开源许可证作为备注。
  4. 单击新建 > 新建目录,目录命名为“.cloudbuild”
  5. “.cloudbuild”目录下依次单击新建 > 新建文件,文件命名为“build.yml”,新建后文件目录如图1所示。
    图1 文件目录

    若YAML文件不存放在“.cloudbuild”目录,可通过“CB_BUILD_YAML_PATH”参数指定YAML文件在代码仓中的路径。参数配置可参考添加自定义参数的配置指导

  6. 单击,参考创建单任务build.xml文件的代码示例,编写“build.yml”文件。

配置构建任务基本信息

  1. 选择导航栏持续交付 > 编译构建,进入编译构建服务页面。
  2. 单击“新建任务”,进入配置“基本信息”页面,参考表2填写构建任务基本信息。然后单击“下一步”,进入“构建模板”页面。
    表2 基本信息配置说明

    参数

    说明

    名称

    创建的编译构建任务名称,可自定义。

    • 支持中英文,数字,下划线“_”和连接符“-”
    • 字符长度范围为1~115。

    所属项目

    创建的编译构建任务所属项目。

    • 以项目入口方式访问编译构建服务时默认填写,无需手动填写。
    • 以服务入口访问时需根据实际情况选择新建构建任务前准备工作中创建的项目。

    代码源

    选择Repo:表示从代码托管拉取代码进行构建。

    代码仓

    选择实际需要编译的代码仓。

    默认分支

    选择仓库默认分支。

    描述

    可选参数。根据实际场景对编译构建任务的描述。字符长度范围0~512。

选择构建模板

在构建模板页面选择“空白构建模板”。选择后单击“确定”,进入“构建步骤”页面。

使用代码化构建时,选择任何构建模板都不影响使用YAML构建。

配置构建步骤

“构建步骤”页面左上角单击“代码化”页签,系统会从配置构建任务基本信息中配置的代码仓库及分支中,自动读取YAML文件。

您可在此处参考配置构建任务“代码化构建”部分的代码示例对YAML文件进行修改。如果在此处修改了YAML文件,那么执行构建任务后,修改后的内容会覆盖创建代码化构建使用的YAML文件中的原YAML文件。

配置完成后,单击“保存”,即可完成构建任务的创建。

相关文档