- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 编译构建服务(CodeArts Build)使用流程
- 购买并授权使用CodeArts Build
- 配置CodeArts Build项目级角色权限
- 新建构建任务
-
配置构建任务
- 构建任务基础配置
- 选择构建步骤
-
配置构建步骤
- 使用Maven构建
- 使用Android构建
- 使用Npm构建
- 使用Gradle构建
- 使用Yarn构建
- 使用gulp构建
- 使用Grunt构建
- 使用mono构建
- 使用PHP构建
- 使用SetupTool构建
- 使用PyInstaller构建
- 使用shell命令构建
- 使用Gnu-arm构建
- 使用Msbuild构建
- 使用CMake构建
- 使用Ant构建
- 使用Kotlin构建
- 使用Go语言构建
- 使用Ionic Android App构建
- 构建Android快应用
- 使用GFortran构建
- 使用Sbt构建
- 使用Grails构建
- 使用Bazel构建
- 使用Flutter构建
- 使用HarmonyOS构建
- 使用构建方舟编译器构建
- 通过Docker命令操作镜像
- 生成单元测试报告
- 自定义构建环境
- 使用自定义环境构建
- 下载软件发布库中的软件包
- 上传软件包到软件发布库
- 上传文件到OBS
- 配置构建任务参数
- 配置构建任务执行计划
- 配置构建任务角色权限
- 配置构建任务事件通知
- 执行构建任务
- 查看构建任务
- 加速构建任务
- 管理构建任务
- 查询审计日志
- 参考
- 旧版手册页面
-
最佳实践
- CodeArts Build最佳实践汇总
- 基于Maven构建产物制作Docker镜像并发布到镜像仓(内置执行机/图形化构建)
- 使用Maven构建上传软件包至私有依赖库(内置执行机/图形化构建)
- 使用Maven构建实现私有依赖包的上传及下载引用(内置执行机/图形化构建)
- 使用NPM构建上传软件包至软件发布库(内置执行机/图形化构建)
- 使用自定义执行机执行Maven构建(自定义执行机/图形化构建)
- 使用Maven构建上传软件包和推送镜像到SWR(内置执行机/代码化构建)
- 使用Maven构建执行多任务构建工程(内置执行机/代码化构建)
- 基于私有依赖库使用Maven构建并上传软件包(内置执行机/图形化构建)
- 使用自定义构建环境执行构建任务(内置执行机/图形化构建)
- 对C/C++构建工程进行构建加速(内置执行机/图形化构建)
- 使用Windows自定义执行机执行Maven构建(自定义执行机/图形化构建)
- HE2E DevOps实践:构建应用部分
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
任务相关API接口
- 根据开始时间和结束时间查看构建任务的构建历史列表
- 查看构建任务的构建历史列表
- KeyStore文件下载
- 查看任务运行状态
- 查看项目下用户的构建任务列表
- 执行构建任务
- 查询指定代码仓库最近一次成功的构建历史
- 获取构建历史详情信息接口
- 根据开始时间和结束时间查看构建任务的构建成功率
- 下载全量构建日志
- 下载构建步骤日志
- 获取构建记录信息
- 获取构建产物详情信息
- 停止构建任务v3
- 停止构建任务v1
- 删除构建任务
- 禁用构建任务
- 恢复构建任务
- 创建构建任务
- 更新构建任务
- 查询构建模板
- 创建构建模板
- 删除构建模板
- 查询通知
- 更新通知
- 取消通知
- 获取构建任务详情
- 下载构建实时日志
- 获取任务构建记录列表
- 获取任务构建记录列表v1
- 查内置执行机规格
- 获取构建任务的角色权限矩阵信息
- 是否已开启内网安全访问
- 获取用户权限
- 获取任务权限矩阵
- 当前用户所在项目所属租户的包周期每月时长是否超额
- 查看用户全部的构建任务列表
- 获取构建记录的构建脚本
- 查看项目下任务名是否存在
- 获取单元测试覆盖率报告列表
- 查询当前租户(计费)类型
- 查询账号是否联邦账号
- 禁用任务
- 查询构建成功率
- 获取单元测试覆盖率报告压缩包
- 查看构建任务构建信息
- 获取通知信息
- 查询租户状态
- 查看任务是否在构建
- 获取覆盖率接口
- 获取任务各阶段信息
- 获取指定工程的简要构建信息
- 构建历史页获取构建次数
- 保存模板使用记录
- 洞察构建时长
- 配置文件权限
- 添加文件权限
- 文件管理文件下载
- 删除文件管理文件
- 删除任务
- 编辑页获取参数类型的接口
- 获取当前用户的项目信息列表
- 查询租户下文件列表
- 获取编译构建默认参数
- 查询用户可使用文件
- 获取项目列表
- 获取指定工程的构建记录列表
- 查询指定构建记录详情
- 查询任务是否已禁用
- 查询官方模板
- 获取构建任务配置的对比差异
- 设置回收站中的任务保留时间
- 查看回收站中删除的构建任务列表
- 删除回收站中的任务
- 清空回收站中的任务
- 恢复回收站中的任务
- 更新文件信息
- 上传文件
- 检查webhook地址参数
- 获取dockerfileTemplate
- 获取镜像模板列表
- 获取当前项目默认角色权限矩阵信息
- 获取修改历史
- 复制任务名
- 获取该任务所有分支信息
- 查看系统预定义参数
- 查看仓库
- 获取租户任务总数和成功率接口
- 获取套餐资源id,影响临期,超期提示
- 获取套餐临期信息
- 检查任务数量是否上限
- 获取代码化构建默认模板
- 获取官方推荐模板
- 执行构建
- 创建构建任务
- 更新构建任务
- 复制构建任务
- 查询项目任务列表
- 根据条件查询特定模板
- 创建构建模板
- 删除构建模板
- 获取构建记录信息
- 获取构建任务详情
- 查询任务状态
- 流水线查看构建任务信息
- 文件管理删除权限
- 文件管理查询权限
- 获取任务构建记录列表
- 详情页获取构建参数
- 获取构建记录的有向无环图
- 应用示例
- 附录
- 历史API接口(待下线)
- 修订记录
- 场景代码示例
-
常见问题
- 通用构建问题
-
Maven构建
- 执行Maven构建时,提示未开通私有依赖仓
- 执行Maven构建时,提示license信息检查不通过
- 使用maven deploy命令上传包失败
- 执行Maven构建时,提示找不到pom文件
- 执行Maven构建时,提示找不到package/symbol
- 使用exec-maven-plugin插件实现Maven和npm混合编译
- 执行Maven构建时,多个子项目和父项目之间引用报错
- 如何配置及清理Maven构建缓存
- 如何查找Maven构建中正确的构建包路径
- 如何使用jib-maven-plugin插件构建Maven工程制作镜像
- 使用Maven构建时,代码更新后构建出来的包还是旧的
- 使用Maven构建时,Maven组件下载缓慢
- Android构建
- Gradle构建
- Msbuild构建
-
Npm构建
- 执行Npm构建时,报错提示JavaScript heap out of memory
- 执行Npm构建时,报错提示Unexpected end of JSON ...
- 执行Npm构建时,报错提示enoent ENOENT: no such file or directory
- 执行Npm构建时,报错提示Module not found: Error: Can't resolve ...
- 执行Npm构建失败,但不显示错误日志
- 执行Npm构建时,报错提示npm cb() never called
- 执行Npm构建时,报错提示gyp ERR! stack Error: EACCES: permission denied
- 执行Npm构建时,报错提示eslint: error 'CLODOP' is not defined
- 执行Npm构建时,报错提示node-sass下载失败
- 执行Npm构建时,报错提示error: could not write config file
- Npm构建耗时且安装依赖缓慢
- 执行Npm构建时,报错提示找不到依赖版本
- 镜像问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
自定义构建环境
CodeArts Build提供大量构建工具,如果已有工具不能满足您的使用要求,如缺少必要的依赖包、工具等,您可以根据需要,通过自定义Dockerfile文件的方式制作镜像并推送至指定的SWR仓库后使用,使用方法可参考使用自定义环境构建。
本节以Maven构建为例,为您介绍如果通过修改Dockerfile文件自定义环境。
自定义构建环境前的准备工作
- 已在容器镜像服务创建组织。组织的约束与限制参考容器镜像服务的约束与限制。
- 如果您制作后的镜像需要推送至华为云其他用户的SWR中,需新建IAM账户服务扩展点。
- 如果您制作后的镜像需要推送至其他镜像仓库,需新建Docker repository服务扩展点。
自定义Dockerfile文件
- 通过项目入口方式访问CodeArts Build服务首页。
- 在编译构建服务首页右上角单击“更多”,在下拉列表选择“自定义构建环境”。
- 进入自定义构建环境页面,选择合适的基础镜像,单击即可下载Dockerfile模板。
图1 Dockerfile模板
- 编辑下载的Dockerfile文件。
- 在导航栏选择“代码 > 代码托管”,单击使用的代码仓名称,进入代码仓详情页。
- 在“代码”页签,选择“新建 > 上传文件”,将Dockerfile文件以及制作镜像过程中需要的所有文件上传到代码仓库根目录。
制作镜像并推送到SWR仓库
- 图形化构建
在配置构建步骤中,“Maven构建”步骤后添加“制作镜像并推送到SWR仓库”构建步骤。
“Maven构建”构建步骤参数保持默认即可,如当前参数配置不满足使用要求,可参考使用Maven构建修改参数配置。“制作镜像并推送到SWR仓库”构建步骤参数配置说明如表1。
表1 制作镜像并推送到SWR仓库参数说明 参数
说明
步骤显示名称
构建步骤的名称,可自定义修改。
- 支持中文、英文、数字、“-”、“_”、英文逗号、英文分号、英文冒号、“.”、“/”、圆括号(中英文)。
- 字符长度范围为1~128。
工具版本
选择使用的Docker版本,使用默认版本即可。
当前编译构建服务支持Docker18.03和Docker20.10版本。
镜像仓库
选择需要推送的镜像仓库。支持推送至华为云镜像仓库SWR和其他镜像仓库,根据实际情况选择即可。
授权用户
推送的镜像仓库的所属用户。支持推送至当前用户和其他用户。
需确保用户对组织内所有镜像具有编辑或管理权限,详见授权管理。
当“镜像仓库”选择“华为云镜像仓库SWR”时需要配置该参数。
IAM账号
在下拉框中选择自定义构建环境前的准备工作中创建的“IAM账户”服务扩展点,通过服务扩展点推送至其他用户的SWR中。
当“授权用户”选择“其他用户”时需要配置该参数。
推送区域
选择需要推送的区域。镜像制作成功后,会将镜像依次推送到选中区域的SWR仓库。
当“镜像仓库”选择“华为云镜像仓库SWR”时需要配置该参数。
镜像仓接入点
选择自定义构建环境前的准备工作中创建的“Docker repository”服务扩展点,通过服务扩展点推送至其他镜像仓库。
当“镜像仓库”选择“其他镜像仓库”时需要配置该参数。
组织
在下拉框中选择自定义构建环境前的准备工作中创建好的组织名,选择镜像推送到SWR后所属的组织。
镜像名字
自定义填写制作完成后的镜像名称。
需以数字或字母开头,仅支持小写字母、数字、“_”、“-”,字符长度为1~255。
镜像标签
用来标记镜像的版本,可自定义。通过“镜像名:标签”可以唯一指定镜像。
仅支持大小写字母、数字、“.”、“_”、“-”,不可以“.”或“-”开头,字符长度为1~128。
工作目录
可选参数。
填写docker build命令中的“上下文路径”参数,该路径是代码仓库根目录的相对路径。
上下文路径,指的是docker在构建镜像时,docker build命令将该路径下的所有内容打包给容器引擎,帮助构建镜像。
Dockerfile路径
可选参数。
Dockerfile文件所在路径,请填写相对于工作目录的路径,如:工作目录为根目录, 且Dockerfile文件在根目录下,则此处填写为“./Dockerfile”。
添加构建元数据到镜像
配置是否将本次构建信息添加到镜像中,镜像制作完成后可以通过docker inspect命令查看镜像元数据。
失败后是否继续运行
当前步骤执行失败后是否继续执行下一个步骤,根据实际使用场景选择是或否。
- 代码化构建
参考以下代码示例,修改在创建代码化构建使用的YAML文件中的BUILD部分代码信息。
1 2 3 4 5 6 7 8 9 10 11 12 13
version: 2.0 # 必须是2.0 steps: BUILD: - build_image: name: buildImage inputs: regions: ["x-x-x", "x-x-xxx"] organization: codeci_test image_name: demo image_tag: ${GIT_COMMIT} dockerfile_path: dockerfile/Dockerfile # set_meta_data: true ignore_fail: true
表2 制作镜像并推送到SWR仓库代码示例参数说明 参数
类型
说明
regions
list
可选参数。
选择要上传的区域SWR。默认上传到当前任务所在region的SWR。如果配置多个region,镜像制作成功后,会将镜像依次推送到填写region的SWR仓库中。
organization
string
配置镜像推送到SWR后所属的组织名称。组织名称为自定义构建环境前的准备工作中创建好的组织名。
image_name
string
可选参数。
自定义填写制作完成后的镜像名称。
需以数字或字母开头,仅支持小写字母、数字、“_”、“-”,字符长度为1~255。
默认值:demo。
image_tag
string
可选参数。
用来标记镜像的版本,可自定义。通过“镜像名:标签”可以唯一指定镜像。
仅支持大小写字母、数字、“.”、“_”、“-”,不可以“.”或“-”开头,字符长度为1~128。
默认值:v1.1。
context_path
string
可选参数。
填写docker build命令中的“上下文路径”参数,该路径是代码仓库根目录的相对路径。
上下文路径,指的是docker在构建镜像时,docker build命令将该路径下的所有内容打包给容器引擎,帮助构建镜像。
默认值:.。
dockerfile_path
string
可选参数。
Dockerfile文件所在路径,请填写相对于工作目录的路径,如:工作目录为根目录, 且Dockerfile文件在根目录下,则此处填写为“./Dockerfile”。
默认值:./Dockerfile。
set_meta_data
bool
可选参数。
配置是否将本次构建信息添加到镜像中,镜像制作完成后可以通过docker inspect命令查看镜像元数据。
- true:添加。
- false:不添加。
默认值:false。
ignore_fail
string
用于控制当前步骤执行失败后是否继续执行下一个步骤。- true:是。
- 为空:否。