文档

配置iOS构建流水线

更新时间:

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

操作说明

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

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

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

    选项

    说明

    阶段名称

    设置本阶段的名称。

    超时时间(分钟)

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

    是否需要运行环境

    设置本阶段是否需要运行环境。构建任务一般需要在特定的环境中执行,例如包含Xcode或Android SDK或HarmonyOS SDK的环境。

    • 构建应用阶段:需要

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

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

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

    执行时机

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

    • 前序阶段成功才执行

    • 前序阶段失败才执行

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

    任务步骤

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

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

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

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

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

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

    image

默认构建步骤说明

  • 代码克隆

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

    选项

    说明

    代码地址

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

    代码分支

    用于设置代码分支。

    重要

    大小写敏感。

    代码访问权限

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

  • 切换Xcode版本

    在iOS场景下,用于切换Xcode的版本。

    选项

    说明

    Xcode版本

    用于设置Xcode的版本。可选择的版本和阶段配置中的镜像强相关:

    • macos-latest / macos-13

      • 15.1

      • 15.0.1

      • 14.3.1

    • macos-12

      • 14.2

      • 14.0

      • 13.4.1

      • 13.2.1

    说明

    如需其他Xcode版本,联系技术支持

  • 切换CocoaPods版本

    在iOS场景下,用于切换CocoaPods的版本。

    选项

    说明

    CocoaPods版本

    用于设置CocoaPods的版本。可选择的版本和阶段配置中的镜像强相关:

    • macos-latest / macos-13

      • 1.14.3

      • 1.12.1

      • 1.11.3

    • macos-12

      • 1.11.2

      • 1.10.2

      • 1.9.3

    说明

    如需其他CocoaPods版本,联系技术支持

  • 安装缓存

    在iOS场景下,用于设置在初次构建后,是否缓存构建相关资源,以便更快完成后续构建。

    选项

    说明

    精确匹配

    用于设置是否进行精确匹配。

    • 开启:不使用低版本Podfile对应的缓存。

    • 关闭:允许使用低版本Podfile对应的缓存。

  • 替换应用版本

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

    选项

    说明

    App版本

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

    build版本

    用于标识发布或未发布的内部版本号。

    【默认值】单调递增的字符串:${{ env.EMAS_PIPELINE_TIMESTAMP }}

    自定义bundleId

    用于设置自定义bundleId,以替换工程的Bundle Identifier。

    Scheme

    用于设置项目的Scheme。

    xcodeproj目录

    用于设置工程根目录到xcodeproj目录的相对路径。

    编译配置

    用于设置工程的编译配置。

  • 安装Apple描述文件

    在iOS场景下,用于将provisioning文件安装到Library。

    选项

    说明

    mobileprovision文件

    用于选择mobileprovision文件。mobileprovision文件须预先设置,具体操作参见配置证书(iOS)

  • 安装p12证书

    在iOS场景下,用于安装p12证书并配置项目。

    选项

    说明

    组织ID

    默认设置为苹果颁发的组织ID。

    证书名

    默认设置为苹果颁发的证书名。

    xcodeproj目录

    用于设置工程根目录到xcodeproj目录的相对路径。

    编译配置

    用于设置工程的编译配置。

    p12证书

    用于选择p12证书。

    p12证书须预先设置,具体操作参见配置证书(iOS)

  • 安装Pods

    在iOS场景下,用于安装或更新pods依赖。

    选项

    说明

    xcodeproj目录

    用于设置工程根目录到xcodeproj目录的相对路径。

    deintegrate

    用于设置是否分解pods。

    repoUpdate

    用于设置是否更新索引库。

    install

    用于设置是否按照用户指定版本,或按照自动选择的最优版本,安装Pods。

    • 如存在Podfile.lock,则按用户指定版本安装Pods;

    • 如不存在Podfile.lock,则根据用户对版本的描述信息,从当前索引库中,自动选择最优版本安装Pods。

    update

    用于设置是否更新索引库,并按照索引库更新依赖安装Pods。

    打印详细信息

    用于在Pod安装或更新时,显示调试级别的日志,便于排查问题。

  • 执行构建命令

    在iOS场景下,用于设置使用的fastlane gym构建应用。

    选项

    说明

    Scheme

    用于设置项目的Scheme。

    xcodeporj目录

    用于设置工程根目录到xcodeproj目录的相对路径。

    xcworkspace

    用于设置工程根目录到xcworkspace目录的相对路径。如使用CocoaPods管理依赖,此选项应为必填。

    configuration

    用于设置工程的编译配置。

    export-method

    用于设置出包的类型。

    【取值范围】

    • app-store

    • ad-hoc

    • package

    • enterprise

    • development

    【默认取值】ad-hoc

    额外编译参数

    用于指定额外的编译参数。多个参数使用分号、逗号或者换行进行分隔 。

    clean

    用于设置编译前是否清洗。

    是否跳过签名

    用于验证代码编译,不会进行构建签名过程。

    自定义包名称

    用于自定义构建出的ipa文件名称。

  • 上传构建产物

    用于收集指定目录及格式(后缀)的构建产物。

    选项

    说明

    路径

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

    说明

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

    是否遍历子目录

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

    文件后缀

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

    说明

    iOS场景下,默认收集后缀为ipa、dSYM.zip的文件。

    是否公开

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

    说明

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

  • 本页导读
文档反馈