文档

配置HarmonyOS构建流水线

更新时间:

配置用于HarmonyOS应用构建的流水线。

操作说明

  1. 打开流水线编辑界面,具体操作参见打开流水线编辑界面

  2. 单击构建阶段的区域框,打开阶段配置右侧栏。

  3. 阶段配置右侧栏,配置相关信息。

    选项

    说明

    阶段名称

    设置本阶段的名称。

    超时时间(分钟)

    设置本阶段的最大执行时间。默认为360分钟。如本阶段的执行时间超过预设值,则执行失败。

    是否需要运行环境

    设置本阶段是否需要运行环境。构建任务如果需要在特定的环境中执行,则需要运行环境,例如:构建环境中包含配置HarmonyOS SDK和nodejs。

    • 构建应用阶段:需要

    • 自定义阶段(串联场景):需要/不需要

    • 自定义阶段(并联场景):需要

    镜像

    如果“是否需要运行环境”选择为需要,则默认镜像harmony-latest;如该选项设置为不需要,则镜像Agentless

    执行时机

    设置在什么情况下执行本阶段。

    • 前序阶段成功才执行

    • 前序阶段失败才执行

    • 无条件执行:即前序阶段执行完成后,无论成功或失败,均执行本阶段。

    任务步骤

    单击添加步骤设置该阶段的任务。

    在弹出的步骤列表中,选择待添加的步骤,将其添加至本阶段的任务列表,并进行相应配置。也可选择已有步骤,根据业务需要修改步骤中的参数。

    具体配置说明请参见使用插件构建自定义流水线

    说明
    • 上传构建产物步骤的参数是否公开开关默认关闭。公开后,您可以直接使用浏览器扫描产物的二维码下载对应产物。

    • 将鼠标滑动至已添加的任务上方,拖动任务,调整任务的顺序。

  4. 单击确定,保存本阶段配置。

    image

默认构建步骤说明

  • 代码克隆

    用于从指定代码仓库的指定分支获取构建应用所需的代码。

    选项

    说明

    代码地址

    默认设置为代码仓库的地址。代码仓库为预先设置,具体操作参见添加代码访问权限

    代码分支

    用于设置代码分支。

    重要

    大小写敏感。

    代码访问权限

    默认设置代码仓库的访问权限。代码仓库的访问权限为预先设置的,具体操作参见添加代码访问权限

  • 安装证书

    安装用于鸿蒙应用签名的证书到指定目录

    选项

    说明

    证书目录

    安装证书到代码指定目录,目录路径为相对代码根目录的路径。

    说明

    默认路径:./sign

    p12证书

    选择已配置的p12证书

    cer证书

    选择已配置的cer证书

    p7b证书

    选择已配置的p7b证书

  • 替换应用版本

    在HarmonyOS场景下,用于设置应用构建时使用的版本号。如未启用替换应用版本号阶段,则在构建应用时,默认使用代码版本号,作为应用版本号。

    选项

    说明

    versionCode

    用于设置鸿蒙App发布的版本号。

    versionName

    用于设置鸿蒙App发布的版本名称。

    bundleName

    (可选)用于设置鸿蒙App标识

  • 依赖包安装

    根据每个模块的oh-package.json5安装依赖

    选项

    说明

    clean

    安装前进行清理。

    install

    安装依赖,如有lockfile,则会优先安装lockfile的版本进行安装。

    update

    检索新版本并安装相应依赖。

  • 执行构建命令

    用于运行自定义Shell脚本。

    选项

    说明

    脚本内容

    用于输入自定义的Shell脚本。在HarmonyOS模板中,已填充默认的构建命令,可自行修改。

    脚本执行目录

    用于输入执行自定义Shell脚本的本地目录。不填写默认代码根目录。

  • 上传app构建产物

    在HarmonyOS场景下,用于收集后缀为app的产物。

    选项

    说明

    路径

    用于设置从代码根目录到构建产物存储目录的相对路径。

    说明

    该选项须按照实际情况进行设置。

    是否遍历子目录

    用于设置在上传构建产物时,是否遍历指定目录的所有子目录。

    文件后缀

    用于设置文件后缀,上传指定文件类型的构建产品。如设置多个后缀,用“,”分隔。

    说明

    HarmonyOS场景下,默认收集后缀为app的文件。

    是否公开

    用于设置构建产物上传完成后,是否所有人可访问读取。默认关闭。

    说明

    如构建Debug包,建议关闭开关键。

  • 上传hap构建产物

    在HarmonyOS场景下,用于收集后缀为hap的产物。

    选项

    说明

    路径

    用于设置从代码根目录到构建产物存储目录的相对路径。

    说明

    该选项须按照实际情况进行设置。

    是否遍历子目录

    用于设置在上传构建产物时,是否遍历指定目录的所有子目录。

    文件后缀

    用于设置文件后缀,上传指定文件类型的构建产品。如设置多个后缀,用“,”分隔。

    说明

    HarmonyOS场景下,默认收集后缀为hap的文件。

    是否公开

    用于设置构建产物上传完成后,是否所有人可访问读取。默认关闭。

    说明

    如构建Debug包,建议关闭开关键。