Setting Up CI/CD for Capacitor Apps

想拥有更快、错误率更低的iOS和Android应用发布? CI/CD管道 Capacitor 通过自动化构建、测试和部署，节省时间达 70%，减少错误率达 60%。本指南涵盖了从设置环境到自动化实时更新的所有内容。 Capgo.

CI/CD 的关键要点：

为什么 CI/CD 对 Capacitor应用程序
重要工具: Xcode, Android Studio, CocoaPods, 等等。
管道设置: 自动化任务如 npx cap sync, 依赖项缓存和平台特定构建。
实时更新与 Capgo: 启用发布后更新，带有分阶段发布和回滚保障。

快速设置步骤：

准备环境: 安装 iOS 和 Android 所需的工具。
配置项目: 更新 capacitor.config.ts 并安全地管理环境变量。
构建管道: 自动安装依赖项、构建和测试两种平台。
优化性能: 使用缓存、并行构建和条件工作流。
添加实时更新: 为安全的、按阶段发布的OTA更新集成 Capgo。

通过CI/CD，Capacitor应用实现更快、更Smooth的发布，同时减少错误和手动干预。准备优化您的工作流程？让我们开始吧！

集成您的现有CI/CD管道与移动功能

准备您的CI/CD环境

一旦您掌握了CI/CD的基本知识，下一步就是设置环境。这是可靠自动化的骨干。

工具和软件设置

确保您安装了这些关键工具：

For iOS Development:

Xcode 14 或更高
Xcode Command Line Tools
CocoaPods 用于管理依赖项

For Android Development:

Android Studio
Android SDK 33 或更高
Java Development Kit (JDK)

要确认您的 Xcode Command Line Tools 已安装，请使用：

xcode-select -p

创建一个 Capacitor 项目

Capacitor 框架文档网站

您的 Capacitor 项目需要正确配置以支持 CI/CD 工作流程。这个 capacitor.config.ts 文件是这个设置的核心：

const config: CapacitorConfig = {
  appId: 'com.example.app',
  webDir: 'build',
  ios: { 
    scheme: 'MyApp'
  }
}

这个文件确保您的项目符合 CI/CD 要求。

设置环境变量

安全地管理凭证是将环境设置与 CI/CD pipeline 链接起来的关键部分。

需要定义的关键变量：

BUILD_ENV: 指定部署阶段（例如 production)
IOS_SIGNING_IDENTITY:您的 code 签名证书
ANDROID_KEYSTORE_PATH:Android.keystore文件的路径

对于Android构建，动态生成一个 local.properties 文件在 CI 过程中:

echo "sdk.dir=$ANDROID_SDK_ROOT" > android/local.properties

在 iOS 构建中，确保您的 CI 平台支持 macOS agent。

检查您的环境是否准备好：

node --version | grep "v16" && xcodebuild -version | grep "Xcode 14" || exit 1

正确管理密钥和凭据可以显著降低应用商店拒绝的机会，正如早期统计数据所示 [1].

创建您的 CI/CD pipeline

一旦您的环境准备好，下一步就是为您的 Capacitor应用程序设置 CI/CD pipeline。这条管道应该高效地管理 web 资产和本机平台构建。

安装和更新依赖项

在 CI/CD 环境中，管理依赖项需要严格的版本控制。从清洁的安装过程开始：

npm install --ignore-scripts
npm install @capacitor/cli

为了加快构建速度，使用依赖项缓存。例如， Azure DevOps 用户已经看到构建时间改善了40-60%：

- task: Cache@2
  inputs:
    key: 'npm | "$(Agent.OS)" | package-lock.json'
    path: |
      node_modules
      android/.gradle
      ios/Pods

iOS和Android构建设置

以下是如何配置两种平台的构建：

iOS构建配置：

steps:
  - task: InstallAppleCertificate@2
    inputs:
      certSecureFile: 'certificate.p12'
      certPwd: $(P12_PASSWORD)
  - script: |
      xcodebuild -workspace ios/App/App.xcworkspace -scheme App -configuration Release -archivePath ios/App/App.xcarchive archive

Android构建配置：

cd android
./gradlew bundleRelease

测试和部署步骤

使用矩阵策略并行运行平台测试：

test:
  steps:
    - run: npm run test:unit
    - run: npm run test:e2e
    - name: Run Platform Tests
      matrix:
        platform: [ios, android]
      run: npm run test:${{ matrix.platform }}

对于部署，设置平台特定的工件处理：

平台	工件类型	分发渠道
iOS	.ipa	App Store Connect
Android	.aab	Google Play Console

正确配置后，使用并行构建可以显著减少管道执行时间。

Once your builds are validated and packaged, you’re ready to move on to live updates with Capgo (discussed in the next section).

sbb-itb-f9944d2

添加 Capgo 实时更新控制台界面

Capgo

将Capgo集成到您的工作流中可以增强CI/CD流程，通过支持发布后更新。以下是如何设置它：

Capgo管道配置

首先，在管道环境中安装 Capgo CLI ：

steps:
  - name: Install Capgo CLI
    run: npm install -g @capgo/cli
  - name: Configure Authentication
    env:
      CAPGO_KEY: ${{ secrets.CAPGO_API_KEY }}

此添加将CI/CD生命周期扩展到自动化构建和部署过程中，包括更新管理。

接下来，包括上传命令在您的构建步骤之后：

- name: Upload Update
  run: |
    capgo upload --api-key $CAPGO_KEY --bundle ./build/app-release.apk
    capgo deploy v${VERSION} --channel production

为了安全更新,配置验证设置如下：

{
  "verification": {
    "checksum": "strict",
    "certificatePinning": true,
    "updateTimeout": 500
  }
}

Capgo 功能概览

功能	描述
端到端加密	显著减少部署错误。
基于通道的部署	根据环境进行定制更新。
分阶段发布	确保更新逐渐分发。

OTA更新指南

通过部署后跟踪这些关键指标来增强您的测试流程：

分阶段部署策略

使用分阶段的发布来控制更新的分发:

- name: Staged Rollout
  run: |
    capgo deploy v1.2.3 --group "beta-users" --rollout 10%
    capgo deploy v1.2.3 --rollout 50%

更新监控

关注这些指标:

采用率: 在首24小时内达到40-60%
无崩溃的会话: 保持在99.5%以上
验证时间: 确保小于500ms

如果崩溃超过可接受的水平，自动回滚:

- name: Rollback Check
  run: |
    if [ $(capgo stats --version v1.2.3 --metric crashes) -gt 2 ]; then
      capgo rollback --channel production
    fi

改进管道性能

专注于三个关键领域可以带来显著的改进：

优化构建速度

对于仅有 web 变更的项目，使用 npx cap sync 可以通过跳过全量原生重建，减少重建时间约 40% 来节省时间。以下是如何实现条件构建的步骤：

- name: Build Strategy
  run: |
    [ "$WEB_ONLY" = true ] && npx cap sync || (./gradlew assembleRelease && xcodebuild ...)

这种方法确保只有必要的组件被重建，从而简化了流程。

版本控制自动化

自动化版本控制可以简化您的工作流程。使用以下脚本来动态设置版本和构建号：

- name: Set Version
  run: |
    VERSION=$(node -p "require('./package.json').version")
    BUILD_NUMBER=$GITHUB_RUN_NUMBER
    echo "APP_VERSION=${VERSION}" >> $GITHUB_ENV
    echo "BUILD_ID=${BUILD_NUMBER}" >> $GITHUB_ENV

此配置还可以设置自动化语义版本：

{
  "scripts": {
    "version": "standard-version",
    "build:prod": "npm version patch && ionic build --prod"
  }
}

这些实践提供了一个坚实的框架，通过以下指标来跟踪和改进管道性能：

每个阶段的构建时间
缓存效率（命中/丢失比率）
峰值资源使用率

多环境设置

通过使用环境特定的配置来简化管理多个环境的过程。

环境	配置文件
开发	`.env.dev`
测试	`.env.staging`
生产	安全存储

您可以使用以下脚本动态配置环境：

- name: Configure Environment
  env:
    API_KEY: ${{ secrets.ENV_SPECIFIC_API_KEY }}
    BUNDLE_ID: ${{ parameters.bundleId }}
  run: |
    echo "ENVIRONMENT=${{ parameters.environment }}" >> $GITHUB_ENV
    echo "API_ENDPOINT=${{ parameters.apiUrl }}" >> $GITHUB_ENV

将这些配置与Capgo的基于频道的部署配对，可以实现精确的、环境特定的更新。这确保了更平滑的部署和更好的对应用程序行为在不同环境下的控制。

概要

CI/CD在开发中的作用

使用CI/CD管道来管理Capacitor应用程序可以显著提高工作流效率。根据行业数据，团队可以实现 50-70% 的发布周期更快 是因为同时进行 iOS 和 Android 构建 [3]. 自动化任务，如依赖项安装和平台同步，减少了部署错误的数量 40-60% [1][2].

例如，使用 Azure DevOps Pipelines 的团队已经自动化了顺序构建步骤和 Xcode 打包。他们还使用了参数化环境来支持开发和生产。这种方法消除了手动 Gradle 和 Xcode CLI 操作的需求，从而确保每次都能创建可靠的工件

这些改进为结合 Capgo 的流畅更新管理奠定了基础

Capgo 更新管理

Capgo 与 CI/CD Pipelines 完美集成，能够即时更新，同时保持与应用商店政策的兼容性。更新只会在通过自动化测试门控的管道中部署

通过结合自动化构建和分阶段发布，团队实现了令人印象深刻的结果： 7 天内覆盖 80% 的用户 并在 1 小时内回滚

一种常见的策略是同时运行多个部署跟踪。自动化构建用于内部测试，而分阶段发布则针对用户分段。这样可以确保更新既快又安全，且由严格的自动化测试门控支持 [1].

常见问题

如何创建一个Capacitor应用?

创建一个Capacitor应用涉及几个简单的步骤:

设置环境:在您的系统上安装Node.js和npm。然后，使用Ionic CLI来启动一个新的项目，带有Capacitor支持:
```
ionic start myApp tabs --capacitor
```
添加平台支持:添加您要目标的平台，如iOS或Android:
```
npx cap add ios
npx cap add android
```
同步您的webcode:确保您的webcode与native平台保持一致，运行:
```
npx cap sync
```

同步步骤对于保持应用在各个平台的一致性以及在CI/CD管道中确保平滑运行至关重要。有关设置环境的更多详细信息，请参阅工具部分。

设置Capacitor应用的CI/CD