跳过主要内容
CapgoLogo
CI/CD

自动Capacitor Android build with GitLab

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

阿尼克·德哈巴尔·巴布

阿尼克·德哈巴尔·巴布

内容营销人员
自动Capacitor Android build with GitLab

使用 GitLab CI 的自动 Android Builds

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

前提条件

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

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

Capgo Build for CI/CD by Capgo

跳过 Fastlane、Gradle 运行器、keystore 和上传脚本的维护 Capgo Build 从您的现有 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 构建提供维护的 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 文件。该文件将是与您的上传密钥相关联的 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 & Admin” > “Service Accounts”
    • 点击“Create Service Account”
    • 为其命名并添加描述
    • 点击“创建并继续”
    • 跳过角色分配并点击“完成”
  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 应用程序。

Conclusion

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

Keep going from Automatic Capacitor Android build with GitLab

如果您正在使用 Automatic Capacitor Android build with GitLab 来规划 CI/CD 自动化，连接它与 Capgo CI/CD 在 Capgo CI/CD 中的产品工作流程 Capgo 原生构建 在 Capgo 原生构建 中的产品工作流程 Capgo 集成 在 Capgo 集成 中的产品工作流程 CI/CD 集成 CI/CD 集成的实现细节 GitHub 动作集成 GitHub 动作集成的实现细节

实时更新 Capacitor 应用

当 web-layer 错误处于活跃状态时，通过 Capgo 将修复推送给用户，而不是等待几天的应用商店批准。用户在后台接收更新，而本机更改仍然在正常审查路径中。

来自 Martin 的人性化支持

立即开始

最新博客

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

Capacitor 应用中的双向通信
开发 移动 +1
2025年4月26日

Capacitor 应用中的双向通信

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

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

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

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

查看我们的博客