GitLab CI による Android 自動ビルド
Capacitor アプリの CI/CD セットアップは複雑で、時間もかかりがちです。押さえておきたいポイントは次のとおりです:
前提条件
始める前に、以下をセットアップする必要があります:
- 管理者アクセス権限を持つ GitLab アカウント
- 適切な署名でGoogle Play Storeに公開済みのアプリ
- Androidの署名キーおよびキーストアファイル
- Play StoreのAPIが有効なGoogle Cloud Consoleプロジェクト
- 適切な権限を持つサービスアカウント
- GitLab CI/CD ワークフローの理解
- Fastlaneの設定に関する知識
- パイプラインを保守・デバッグする時間
Capgo によるCI/CD向けCapgo Build
Fastlane、Gradle runner、keystore、アップロードスクリプトのメンテナンスをスキップ。 Capgo のビルド 既存の CI/CD パイプラインから署名済みネイティブ Android ビルドを実行:
- パイプラインと連携: Web build後に、GitLab CI、GitHub Actions、Jenkins、またはローカルスクリプトからCapgo Buildをトリガーできます。
npx cap sync. - CIシークレットで署名: Androidのkeystore、key alias、パスワード、Play ConsoleのサービスアカウントJSONは、自分のCI secretsに保管します。
- ネイティブランナーの運用不要: Capgo Buildはメンテナンス済みのAndroidビルド環境を提供するため、SDKイメージ、Gradleキャッシュの問題、Fastlane laneを管理する必要はありません。
- アーティファクトと提出: QA用の署名済みアーティファクトをダウンロードするか、Capgo CLI からリリースビルドを提出できます。
料金プラン
- Capgo プランは月額$12から
- OTAアップデートと月間約15回のNative Buildを含む
- 追加のビルド時間はクレジットで分単位課金されます
手動セットアップガイド
手順は以下の通りです:
この記事の手順
- Fastlaneファイルをコピー
- GitLab の暗号化シークレットに秘密情報を保存する
- Google Play のサービスアカウントキーの作成と保存
- Android の署名キーを保存する
- 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 は、GitHub のリポジトリシークレットと同様に、暗号化された CI/CD 変数を保存する方法を提供しています。機密情報を安全に保存するには。
- GitLab プロジェクトの「設定」に移動します。
- CI/CD > 変数に移動します
- 以下の変数を追加します:
- ANDROID_KEYSTORE_FILE: base64エンコードされた
.jksまたは.keystoreAndroidビルドの署名に使用するファイル。Play App Signingを使用している場合はアップロードキーに関連付けられたkeystoreファイル、それ以外の場合はアプリ署名キーです。 - KEYSTORE_KEY_PASSWORD: keystoreファイルに関連付けられたパスワード
- KEYSTORE_KEY_ALIAS: keystoreのエイリアス
- KEYSTORE_STORE_PASSWORD: 秘密鍵のパスワード
- DEVELOPER_PACKAGE_NAME: com.example.appのようなAndroidアプリID
- PLAY_CONFIG_JSON: base64エンコードされたサービスアカウントキーのJSON。
Google Playサービスアカウントキーの作成
シークレットを生成するには、 PLAY_CONFIG_JSON 以下の手順に従ってください:
- 以下にアクセスしてください: Google Cloud Console
- 新しいプロジェクトを作成するか、既存のプロジェクトを選択します
- Google Play Android Developer API を有効にします
- サービスアカウントを作成します:
- 「IAM & 管理」>「サービスアカウント」に移動します
- 「サービスアカウントを作成」をクリックします
- 名前と説明を入力します
- 「作成して続行」をクリックします
- ロールの割り当てをスキップし、「完了」をクリックします
- JSONキーを生成します:
- リストからサービスアカウントを探します
- 3点リーダーメニュー > 「キーの管理」をクリック
- 「キーの追加」> 「新しいキーの作成」をクリック
- JSON形式を選択
- 「作成」をクリック
- Play Consoleでサービスアカウントにアプリへのアクセス権を付与します:
- 以下に移動します: Play Console
- 「ユーザーと権限」に移動
- 「新しいユーザーの招待」をクリック
- サービスアカウントのメールアドレスを入力(@*.iam.gserviceaccount.comで終わる)
- 「本番環境へのリリース」権限を付与
- 「ユーザーを招待」をクリック
- JSONキーをbase64に変換します:
base64 -i path/to/your/service-account-key.json | pbcopy - base64エンコードされた文字列を
PLAY_CONFIG_JSONGitLabの変数として追加します
GitLab CI/CDパイプラインのセットアップ
プロジェクトのルートに.gitlab-ci.ymlファイルを作成してCI/CDパイプラインを定義します。パイプラインの構成例を以下に示します:
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リポジトリに新しいタグをpushすると、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 Native Build Capgo Native Buildsでのプロダクトワークフローについては、 Capgo インテグレーション Capgo インテグレーションでのプロダクトワークフロー向けに、 CI/CD 連携 CI/CD Integrationの実装詳細については、 GitHub Actions 連携 GitHub Actions Integrationの実装詳細については。