跳过主要内容
Capgo logo
CI/CD

自动Capacitor Android构建与GitLab

如何在5分钟内使用fastlane和GitLab为您的Android Ionic应用设置CI/CD管道

阿尼克·德哈巴尔·巴布

阿尼克·德哈巴尔·巴布

内容营销人员
自动Capacitor Android构建与GitLab

使用GitLab CI的自动Android构建

为Capacitor应用设置CI/CD可能会很复杂且耗时。以下是您需要了解的内容：

前置条件

在开始之前，您需要设置：

  • 拥有 GitLab 帐户并具有管理员权限
  • 您的应用程序已在 Google Play 商店中以正确签名发布
  • Android 签名密钥和 keystore 文件
  • Google Cloud Console 项目，已启用 Play Store API
  • 具有适当权限的服务帐户
  • 了解 GitLab CI/CD 工作流
  • 了解 Fastlane 配置
  • 维护和调试管道所需的时间

Capgo 使用 Capgo 构建管道

跳过 Fastlane、Gradle 运行器、keystore 和上传脚本的维护 Capgo 构建 从您的现有 CI/CD pipeline 运行已签名的本机 Android 构建：

  • 与您的管道兼容: Trigger Capgo Build from GitLab CI, GitHub Actions, Jenkins, or local scripts after your web build and npx cap sync.
  • 从 CI 秘密中签名: 在您的 CI 秘密中保留 Android 密钥库、密钥别名、密码和 Play Console 服务帐号 JSON
  • 无本地运行器维护: Capgo Build 提供维护的 Android 构建环境，因此您不需要管理 SDK 图像、Gradle 缓存问题或 Fastlane 通道
  • 工件和提交: 下载签名工件进行 QA 或通过 Capgo CLI 提交发布版本

定价

  • Capgo 计划从每月 $12 开始
  • 包括 OTA 更新和约 15 个本机构建每月
  • 额外的构建分钟通过信用额度按分钟计费

设置 Capgo 在 CI/CD 中

手动设置指南

以下是您需要做的事情：

在发布后遵循的步骤

  1. 复制 Fastlane 文件
  2. 将您的密钥存储在 GitLab 加密密钥中
  3. 创建并存储 Google Play 服务帐户密钥
  4. 存储您的 Android 签名密钥
  5. 设置您的 GitLab 工作流 .yml 文件

1. 复制 Fastlane 文件

Fastlane 是一款 Ruby 库，用于自动化移动开发的常见任务。使用 Fastlane，可以配置自定义的“道线”，这些道线包含一系列的“动作”，这些动作执行您通常使用 Android Studio 执行的任务。您可以在 Fastlane 中做很多事情，但在本教程中，我们将仅使用核心动作的一小部分。

在项目根目录创建一个 Fastlane 文件夹，并复制以下文件: Fastlane

default_platform(:android)

KEYSTORE_KEY_ALIAS = ENV["KEYSTORE_KEY_ALIAS"]
KEYSTORE_KEY_PASSWORD = ENV["KEYSTORE_KEY_PASSWORD"]
KEYSTORE_STORE_PASSWORD = ENV["KEYSTORE_STORE_PASSWORD"]

platform :android do
    desc "Deploy a beta version to the Google Play"
    private_lane :verify_changelog_exists do |version_code: |
      changelog_path = "android/metadata/en-US/changelogs/#{version_code}.txt"
      UI.user_error!("Missing changelog file at #{changelog_path}") unless File.exist?(changelog_path)
      UI.message("Changelog exists for version code #{version_code}")
    end

    private_lane :verify_upload_to_staging do |version_name: |
      UI.message "Skipping staging verification step"
    end
    lane :beta do
				keystore_path = "#{Dir.tmpdir}/build_keystore.keystore"
				File.write(keystore_path, Base64.decode64(ENV['ANDROID_KEYSTORE_FILE']))
				json_key_data = Base64.decode64(ENV['PLAY_CONFIG_JSON'])
				previous_build_number = google_play_track_version_codes(
					package_name: ENV['DEVELOPER_PACKAGE_NAME'],
					track: "internal",
					json_key_data: json_key_data,
				)[0]

				current_build_number = previous_build_number + 1
				sh("export NEW_BUILD_NUMBER=#{current_build_number}")
        gradle(
          task: "clean bundleRelease",
          project_dir: 'android/',
          print_command: false,
          properties: {
            "android.injected.signing.store.file" => "#{keystore_path}",
            "android.injected.signing.store.password" => "#{KEYSTORE_STORE_PASSWORD}",
            "android.injected.signing.key.alias" => "#{KEYSTORE_KEY_ALIAS}",
            "android.injected.signing.key.password" => "#{KEYSTORE_KEY_PASSWORD}",
						'versionCode' => current_build_number
          })
        upload_to_play_store(
					package_name: ENV['DEVELOPER_PACKAGE_NAME'],
					json_key_data: json_key_data,
          track: 'internal',
          release_status: 'completed',
          skip_upload_metadata: true,
          skip_upload_changelogs: true,
          skip_upload_images: true,
          skip_upload_screenshots: true,
        )
    end
    lane :build do
      gradle(
        task: "clean bundleRelease",
        project_dir: 'android/',
        print_command: false,
        properties: {
          "android.injected.signing.store.file" => "#{keystore_path}",
          "android.injected.signing.store.password" => "#{KEYSTORE_STORE_PASSWORD}",
          "android.injected.signing.key.alias" => "#{KEYSTORE_KEY_ALIAS}",
          "android.injected.signing.key.password" => "#{KEYSTORE_KEY_PASSWORD}",
        })
    end
    lane :prod_release do
      build_gradle = File.read("../android/app/build.gradle")

      verify_changelog_exists(version_code: build_gradle.match(/versionCode (\d+)/)[1])
      verify_upload_to_staging(version_name: build_gradle.match(/versionName '([\d\.]+)'/)[1])

      supply(
        track_promote_to: 'beta',
        skip_upload_apk: true,
        skip_upload_aab: true,
        skip_upload_metadata: false,
        skip_upload_changelogs: false,
        skip_upload_images: false,
        skip_upload_screenshots: false
      )
    end
end

在 GitLab CI/CD 变量中存储您的机密

GitLab 提供了一个存储加密 CI/CD 变量的方式，类似于 GitHub 的仓库机密。为了安全地存储您的敏感信息。

  1. 前往您的 GitLab 项目的设置
  2. 导航到 CI/CD > 变量
  3. 添加以下变量：
  • ANDROID_KEYSTORE_FILE：用于签署 Android 构建的 base64 编码 .jks 或 .keystore 文件，用于签署 Android 构建。这将是与您的上传密钥相关联的 keystore 文件（如果使用 Play App Signing），或您的应用签名密钥。
  • KEYSTORE_KEY_PASSWORD：与 keystore 文件相关的密码
  • KEYSTORE_KEY_ALIAS：密钥存储别名
  • KEYSTORE_STORE_PASSWORD：私钥密码
  • DEVELOPER_PACKAGE_NAME：您的 Android 应用 ID，如 com.example.app
  • PLAY_CONFIG_JSON: 基于64位的服务帐号密钥JSON。

创建Google Play服务帐号密钥

为了生成 PLAY_CONFIG_JSON 密钥，请遵循以下步骤：

  1. 访问 Google Cloud控制台
  2. 创建一个新项目或选择一个现有的项目
  3. 启用Google Play Android开发者API
  4. 创建服务帐号：
    • 访问“IAM & 管理”> “服务帐号”
    • 点击“创建服务帐号”
    • 为其命名并添加描述
    • 点击“创建并继续”
    • 跳过角色分配并点击“完成”
  5. 生成 JSON 密钥：
    • 在列表中找到您的服务帐户
    • 点击三点菜单 > “管理密钥”
    • 点击“添加密钥” > “创建新密钥”
    • 选择 JSON 格式
    • 点击“创建”
  6. 在 Play Console 中为您的应用授予服务帐户访问权限：
    • 前往 Play Console
    • 导航到“用户和权限”
    • 点击“邀请新用户”
    • 输入服务帐号邮箱（以 @*.iam.gserviceaccount.com 结尾）
    • 授予“发布到生产环境”权限
    • 点击“邀请用户”
  7. 将 JSON 密钥转换为 base64： 
    base64 -i path/to/your/service-account-key.json | pbcopy
  8. 将 base64 编码的字符串添加为 PLAY_CONFIG_JSON GitLab 变量

设置您的 GitLab CI/CD Pipeline

在您的项目根目录创建一个 .gitlab-ci.yml 文件来定义您的 CI/CD pipeline。以下是如何结构您的 pipeline 的示例：


image: mingc/android-build-box:latest

stages:
  - build
  - upload_to_capgo
  - build_and_upload_android

build:
  stage: build
  tags:
    - saas-linux-xlarge-amd64
  cache:
    - key:
        files:
          - bun.lockb
      paths:
        - .node_modules/
  script:
    - npm install
    - npm run build
  artifacts:
    paths:
      - node_modules/
      - dist/
  only:
    - master

upload_to_capgo:
  stage: upload_to_capgo
  tags:
    - saas-linux-xlarge-amd64
  script:
    - npx @capgo/cli@latest bundle upload -a $CAPGO_TOKEN -c dev
  dependencies:
    - build
  when: manual
  only:
    - master

build_and_upload_android:
  tags:
    - saas-linux-xlarge-amd64
  stage:    build_and_upload_android
  cache:
    - key:
        files:
          - android/gradle/wrapper/gradle-wrapper.properties
      paths:
        - ~/.gradle/caches/
  script:
    - npx cap sync android
    - npx cap copy android
    - bundle exec fastlane android beta # We do create a tag for the build to trigger XCode cloud builds
  dependencies:
    - build
  when: manual
  only:
    - master

触发管道

当您将新标签推送到您的 GitLab 仓库时，GitLab CI/CD 将自动触发定义的管道，该管道将使用 Fastlane 构建和部署您的 Android 应用程序。请确保根据您的项目结构和要求调整路径和依赖项。这种设置将有助于您在 GitLab CI/CD 上自动部署 Android 应用程序。

Create a .gitlab-ci.yml file at the root of your project to define your CI/CD pipeline. Below is an example of how you can structure your pipeline:__CAPGO_KEEP_0__

结论

通过使用mingc/android-build-box Docker镜像配置GitLab CI/CD，您可以自动化Android应用程序的构建过程，使您的开发流程更加高效和可靠。这一自动化可以为您腾出时间，专注于应用程序开发的核心方面，从而帮助您更高效地交付高质量的Android应用程序。

实时更新 Capacitor 应用

当 web 层面 bug 活跃时，通过 Capgo 将修复推送到用户，而不是等待几天的应用商店审批。用户在后台接收更新，而本机更改保持在正常审批路径中。

立即开始

最新博客文章

Capgo 为您提供创建真正专业的移动应用所需的最佳见解。

2-Way Communication in Capacitor Apps
开发,移动,更新
2025年4月26日

2-Way Communication in Capacitor Apps

避免的5种OTA更新常见错误
开发,安全,更新
2025年4月13日

避免的5种OTA更新常见错误

移动应用实时更新的5项安全最佳实践
开发,移动,更新
2025年1月14日

移动应用实时更新的5个安全最佳实践

查看所有博客文章