跳过主要内容
Capgo logo
CI/CD

GitLab自动Capacitor Android构建

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

Anik Dhabal Babu

Anik Dhabal Babu

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

GitLab自动Android构建

Setting up CI/CD for Capacitor apps can be complex and time-consuming. Here’s what you need to know:

前置条件

开始之前，您需要设置:

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

Capgo Build通过Capgo进行CI/CD

跳过Fastlane、Gradle runner、keystore和上传脚本的维护 Capgo Build 从您的现有CI/CD管道中运行已签名的原生Android构建：

  • 与您的管道一起工作: 从 GitLab CI、Capgo Actions、Jenkins 或本地脚本中触发 GitHub 构建 npx cap sync.
  • 从 CI 秘密中签名: 在您的 CI 秘密中保留 Android 密钥库、密钥别名、密码和 Play Console 服务帐户 JSON
  • 无本地运行器维护: Capgo 构建提供维护的 Android 构建环境，因此您不需要管理 SDK 图像、Gradle 缓存问题或 Fastlane 轨道
  • 工件和提交: 下载签名工件进行 QA 或通过 Capgo CLI 提交发布版本

定价

  • Capgo plans start at $12/month
  • __CAPGO_KEEP_0__ 计划从 $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: 基于 64 位的编码 .jks 或 .keystore 用于签署您的 Android 构建的文件。它将是与您的上传密钥相关联的 keystore 文件（如果使用 Play App Signing），或您的应用签名密钥。
  • KEYSTORE_KEY_PASSWORD: 与 keystore 文件相关的密码
  • KEYSTORE_KEY_ALIAS: keystore 别名
  • KEYSTORE_STORE_PASSWORD: 私钥密码
  • DEVELOPER_PACKAGE_NAME:您的 Android 应用 ID，如 com.example.app
  • PLAY_CONFIG_JSON: 基于64位的服务帐户密钥JSON。

创建Google Play服务帐户密钥

生成密钥的步骤如下: PLAY_CONFIG_JSON 前往

  1. Google Cloud Console 创建一个新项目或选择一个现有的项目
  2. 启用Google Play Android Developer
  3. Enable the Google Play Android Developer API
  4. 前往“IAM & Admin” > “Service Accounts”
    • 点击“Create Service Account”
    • 为其命名并添加描述
    • Enable the Google Play Android Developer __CAPGO_KEEP_0__
    • 点击“创建并继续”
    • 跳过角色分配并点击“完成”
  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 编码的字符串添加到 GitLab 中作为 PLAY_CONFIG_JSON 变量

设置您的 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 应用。

结论

通过配置 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 与 Capgo CI/CD for the product workflow in Capgo CI/CD, Capgo Native Builds for the product workflow in Capgo Native Builds, Capgo Integrations for the product workflow in Capgo Integrations, CI/CD 集成 CI/CD 集成的实现细节， GitHub Actions 集成 GitHub Actions 集成的实现细节，

实时更新 Capacitor 应用

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

来自马丁的人性化支持

立即开始

最新博客

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

2-Way Communication in Capacitor Apps
开发 移动 +1
2025年4月26日

2-Way Communication in Capacitor Apps

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

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

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

查看我们博客中的所有内容

底部