使用 GitLab CI 的自动 Android 构建

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

前置条件

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

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

Capgo Build for CI/CD by Capgo

跳过Fastlane、Gradle runner、keystore和upload-script的维护 Capgo Build 从您的现有CI/CD管道中生成已签名的原生Android构建：

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

定价

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

设置 Capgo Build 在 CI/CD

手动设置指南

请按照以下步骤操作：

发布后需要遵循的步骤

复制 Fastlane 文件
在 GitLab 中使用加密的 secrets 存储您的机密信息
创建并存储 Google Play 服务帐号密钥
存储您的 Android 签名密钥
配置您的 GitLab 工作流 .yml 文件

1. 复制 Fastlane 文件

Fastlane 是一款用于自动化移动开发任务的 Ruby 库。使用 Fastlane，可以配置自定义的“道线”（lanes），这些道线包含一系列的“动作”（actions），这些动作执行您通常在 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 的仓库机密信息。为了安全地存储您的敏感信息。

前往您的 GitLab 项目的设置。
导航到 CI/CD > 变量
添加以下变量：

ANDROID_KEYSTORE_FILE：基于 base64 编码的 .jks 或 .keystore 用于签署 Android 构建的文件。这将是使用 Play App Signing 的上传密钥相关的 keystore 文件，或者您的应用签名密钥。
KEYSTORE_KEY_PASSWORD：与 keystore 文件相关的密码
KEYSTORE_KEY_ALIAS：密钥存储别名
KEYSTORE_STORE_PASSWORD：私钥密码
DEVELOPER_PACKAGE_NAME：您的 Android 应用 ID，如 com.example.app
PLAY_CONFIG_JSON：服务账户密钥 JSON 的 base64 编码。

创建 Google Play 服务账户密钥

To generate the secret, follow these steps: PLAY_CONFIG_JSON 前往

Google Cloud Console 创建一个新项目或选择一个现有的项目
启用 Google Play Android Developer __CAPGO_KEEP_0__
Enable the Google Play Android Developer API
前往 “IAM & Admin” > “Service Accounts”
- 点击 “Create Service Account”
- 为其命名并添加描述
- 点击 “Create and Continue”
- 跳过角色分配并点击 “Done”
- Enable the Google Play Android Developer __CAPGO_KEEP_0__
生成 JSON 密钥：
- 在列表中找到您的服务帐户
- 点击三点菜单 > “管理密钥”
- 点击 “添加密钥” > “创建新密钥”
- 选择 JSON 格式
- 点击 “创建”
在 Play Console 中为服务帐户授予应用访问权限：
- 前往 Play Console
- 导航到 “用户和权限”
- 点击 “邀请新用户”
- 输入服务帐户电子邮件（以 @*.iam.gserviceaccount.com 结尾）
- Grant “Release to production” permission
- 点击“邀请用户”

将 JSON 键转换为 base64:

base64 -i path/to/your/service-account-key.json | pbcopy

将 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 应用程序。

结论

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

继续使用 GitLab 自动 Capacitor Android 构建

如果您正在使用 使用 GitLab 自动 Capacitor Android 构建 规划 CI/CD 自动化,连接它到 Capgo CI/CD 在 Capgo CI/CD 中的产品工作流程 Capgo 原生构建在 Capgo 原生构建中 Capgo 集成在 Capgo 集成中 CI/CD 集成 CI/CD 集成的实现细节 GitHub Actions 集成为 GitHub Actions 集成的实现细节。

自动 Capacitor Android 构建与 GitLab