平台上手

平台上手

在开始使用平台前，首先需要搭建好本地环境。

准备工作

需要企业开启了发布商能力（用于发布移动 App）
准备好一个项目
项目中创建应用，选择 移动应用，选择模版 terminusMobileTemplates 填写必要信息
等待片刻后代码初始化完毕

订阅所需模块库

模块库是由企业内部各团队研发，用于共享的代码，一般通俗的称为“二方包”。通过使用已被共享的模块库，可以有效的复用公共逻辑，显著加快研发工作。

::: tip 使用三端统一框架技术时，模块库等同于 npm 包 :::

通过申请订阅模块可以将模块引入应用中，同时通过一键复制方便快速将依赖库使用配置同步进入代码。

请进入 DevOps 平台 > 我的项目 > 应用列表 > 应用设置 > 更多设置 > 订阅模块 操作。

::: tip 申请订阅模块库后，需要企业管理员在后台同意后才能够使用“一键复制”功能。 :::

证书准备

Android/iOS 打包需要提前准备证书。证书由企业管理员进行创建

在平台上使用引用证书功能，向企业管理员申请证书授权。

请进入 DevOps 平台 > 我的项目 > 应用列表 > 应用设置 > 更多设置 > 引用证书。

授权通过后开启“推送到变量配置”，选择将变量推送到的环境，以及 keystore 文件路径、密码，key 别名、密码等设置变量名，平台将通过环境变量的方式将具体的文件路径、密码，key 别名、密码等配置传入打包环境。通过环境变量将这些参数传入打包命令：

cd android && ./gradlew clean assembleRelease -DRelease-keystore=((RELEASE_CERT_FILE_PATH)) -DRelease-keystore-password=((RELEASE_CERT_FILE_PASSWORD)) -DRelease-key-alias=((RELEASE_CERT_KEY_ALIAS)) -DRelease-key-password=((RELEASE_CERT_KEY_PASSWORD))

::: tip 关于如何运行这个命令，将会在构建出第一个 APP 提及。 :::

监控集成

::: warning 当前版本需要先获得 APP 内测分发 :::

配置完内测分发 APP 之后，在打包命令中可以通过 ((AK)), ((AI)) 的方式取得监控埋点 id (AK 和 AI 联合作为 APP 分发的唯一标识)

cd android && ./gradlew clean assembleRelease -Dak=((AK)) -Dai=((AI))

::: tip 关于如何运行这个命令，将会在构建出第一个 APP 提及。 :::

获得 APP 内测分发

平台提供了 APP 内测分发能力。通过将开发者构建出的 APP 安装包推送到 APP 内测分发，企业内成员可以从平台的分发渠道下载和安装 APP：

用户手机扫码安装界面：

在开始构建前，要先获得 APP 内测分发。

::: warning 请确保企业开启了发布商功能，并且管理员已在内测分发平台创建了一个 APP。 :::

通过版本推送设置，将应用与内测分发平台中的 APP 关联，可分别为四个构建环境设置推送的 APP。

::: tip 设置关联后，平台会自动同步 AK、AI 到环境配置，打包命令可以直接使用这个配置，并集成监控埋点 :::

请进入 DevOps 平台 > 我的项目 > 应用列表 > 应用设置 > 更多设置 > 版本推送 操作。

构建出第一个 APP

基于准备工作初始化后的代码，进行构建。

定义流水线

首先需要编写 pipeline.yml 以描述构建过程。

pipeline.yml 是描述一个从代码编译构建到应用部署的流水线的配置文件；简单的完成基于 APP 构建和推送，一般可以设置 4 个 stage 来组成 pipeline.yml，4 个 stage 按照书写顺序依次执行，分别是：

拉取 Git 源码
基于源码编译、构建，制作 APP 安装包
生成版本产物
基于版本产物推送至 APP 内测分发平台

4 个 stage 分别可用如下 Action 来执行：

:::tip

此处介绍的 4 个 stage 只能算是最基本的，可以按照自己的需求设置更多的 stage，比如：单元测试等。另外，stage 和 Action 并不是一对一的关系，一个 stage 中可以设置多个 Action 同时并行执行。

:::

完整 pipeline.yml，更多功能可以参考 pipeline.yml 规范。

version: "1.1"
stages:
  - stage:
      - git-checkout:
          alias: repo
          params:
            depth: 1
  - stage:
      - ios:
          params:
            context: ${repo}
            commands:
              - jenkins-mobile-cli build --platform=rn-ios --ios-scheme=example_test --ios-configurations=Test  --GCC_PREPROCESSOR_DEFINITIONS='$(inherited) TERMINUS_AI=\@\"((AI))\" TERMINUS_AK=\@\"((AK))\"' --log-quiet=true --static-scan=false
            targets:
              - ios/build/Build/Products/Test-iphoneos/example_test.ipa
      - android:
          params:
            context: ${repo}
            commands:
              - npm i
              - cd android && ./gradlew clean assembleRelease -Dai=((AI)) -Dak=((AK)) -DENV_SWITCH=1
            target: android/app/build/outputs
  - stage:
      - release:
          params:
            release_mobile:
                files:
                  - ${ios}/example_test.ipa
                  - ${android}/outputs/apk/release/app-release.apk
  - stage:
      - mobile-publish:
          params:
            release_id: ${release:OUTPUT:releaseID}
            readme_file: ${repo}/README.md