メインコンテンツへスキップ
CI/CD

証明書付き GitHub actions による Capacitor iOS 自動ビルド

fastlaneとGitHub ActionsでiOS IonicアプリのCI/CDパイプラインを5分で構築する(2024年)

GitHubアクションと証明書Capgoによる自動Capacitor iOSビルドのブログイラスト

Capacitor アプリの CI/CD セットアップは複雑で、時間もかかりがちです。押さえておきたいポイントは次のとおりです:

現在は以下を使用することを推奨しています: Capgo CLI を使用した Capgo Build ネイティブ Capacitor ビルド用。 このFastlaneガイドは、既存の GitHub Actionsパイプラインを保守するチーム向けに残しています。ただし、新規のiOSビルドには、Fastlane、Xcodeランナー、証明書、アップロードスクリプトを自分で保守しなくて済む Capgo CLI の使用を推奨します。

Capgo によるCI/CD向けCapgo Build

Fastlane、Xcodeランナー、証明書、プロビジョニングプロファイル、アップロードスクリプトのメンテナンスを不要に。 Capgo のビルド 既存のCI/CDパイプラインから、署名済みのネイティブiOSビルドを実行します:

  • パイプラインと連携: Webビルド後に、GitHub Actions、GitLab CI、Jenkins、またはローカルスクリプトから Capgo Build をトリガーし、 npx cap sync.
  • CIシークレットで署名: App Store Connectのキー、証明書、プロビジョニングプロファイル、パスワード、チームIDは、自分のCIシークレットに保管します。
  • ネイティブランナーの運用不要: Capgo Buildはメンテナンス済みのAppleビルド環境を提供するため、macOSランナー、Xcodeイメージ、Fastlaneレーンを管理する必要はありません。
  • アーティファクトと提出: QA用の署名済みアーティファクトをダウンロードするか、Capgo CLI からリリースビルドを提出できます。

料金プラン

  • Capgo プランは月額$12から
  • OTAアップデートと月間約15回のNative Buildを含む
  • 追加のビルド時間はクレジットで分単位課金されます

CI/CDでCapgo Buildをセットアップする

手動セットアップガイド

手順は以下の通りです:

FastlaneとGitHub Actions、証明書を使ったiOSの継続的デリバリー

前提条件

チュートリアルを続ける前に:

  • Fastlaneが インストール されていることを確認してください。
  • iOS Developer Programに加入していることを確認してください。

料金に関する重要な情報

GitHub Actionの料金

https://github.com/features/actions

本サービスは「無料」 ですが、選択したマシンによって上限があります。
今回は macOS マシンの価格と制限はスクリーンショットで確認できます(価格はチュートリアル作成時点のもので、今後変更される可能性があります)。

要件と価格について確認したところで、進めていきましょう。

注: 本記事では、App Store Connect にアプリが作成済みであることを前提としています。重要な情報は Fastlane がコピーします!

このチュートリアルで学べること

この記事の手順

  1. Fastlane を用いた App Store Connect API の利用
    • 要件:
      • App Store Connect API Keyの作成
      • App Store Connect API Key の使用
  2. Fastlaneファイルをコピー
  3. GitHub Actions の設定

1. FastlaneでApp Store Connect API を使う

2021年2月から、App Store Connectにサインインするすべてのユーザーに、2ファクタ認証または2段階認証が必須になります。Apple IDのこの追加のセキュリティレイヤーにより、アカウントにアクセスできるのは本人だけであることが保証されます。
から Apple サポート

要件

Fastlane が App Store Connect の API を使用してアプリをアップロードするには、以下の情報が必要です 3 :

  1. 発行者 ID
  2. Key ID
  3. キーファイルまたはキー内容

App Store Connect API キーの取得

キーを生成するには、App Store Connect で Admin 権限が必要です。権限がない場合は、該当する担当者にこの記事を送ってください。

  1. ログイン App Store Connect.

  2. 選択します ユーザーとアクセス.

App Store Connectのユーザーアクセス

3 — Integrationタブを選択します。

App Store Connect API 連携

  1. 「API キーを生成」または「追加(+)」ボタンをクリックします。

App Store Connect API キーの作成

  1. キーの名前を入力してください。名前は参照用であり、キー自体の一部ではありません。

App Store Connect API キー作成時の名前

6 — Access でキーのロールを選択します。キーに適用されるロールは、チーム内のユーザーに適用されるロールと同じです。詳細は ロールの権限 を参照してください。次を選択することを推奨します: アプリマネージャー.

  1. 「Generate」をクリックします。

API キーのアクセス権を特定のアプリのみに制限することはできません。

新しいキーの名前、キー ID、ダウンロードリンク、およびその他の情報がページに表示されます。

App Store Connect でのキーのダウンロード

必要な3つの情報をここで取得できます。
<1> Issue ID。(APPLE_ISSUER_ID secret)
<2> Key ID。APPLE_KEY_ID secret)
<3> “Download API Key” をクリックして、API の秘密鍵をダウンロードしてください。ダウンロードリンクは、秘密鍵がまだダウンロードされていない場合にのみ表示されます。Apple は秘密鍵のコピーを保持しません。そのため、ダウンロードできるのは一度だけです。

🔴 秘密鍵は安全な場所に保管してください。キーを他人と共有したり、code リポジトリに保存したり、クライアント側の code に含めたりしないでください。

App Store Connect API Key の使用

認証用の JWT トークンを作成するには、API Key ファイル(ダウンロードした p8 ファイル)、Key ID、および Issuer ID が必要です。これらの情報を Fastlane に渡す方法はいくつかありますが、ここでは Fastlane の新しい action を使う方法を選びました。 app_store_connect_api_key. その他の方法については Fastlane のドキュメントで確認できます。環境変数を設定できる一般的な CI で扱うには、この方法が一番簡単だと思うので紹介しています。

ダウンロードした p8 ファイルを Base64 に変換し、secret として保存してください(APPLE_KEY_CONTENT).

base64 -i APPLE_KEY_CONTENT.p8 | pbcopy

これで、API キーを使って Fastlane で App Store Connect を管理できるようになりました。最高!

2. 証明書

Xcode を開き、以下へ移動します 設定 > アカウント > Apple ID > チーム チームを選択します。

Code の署名ID

次をクリックします: 証明書の管理.

証明書をまだ作成していない場合は、新しく作成できます。

次をクリックします: + を選択し、 Apple Distribution

Apple Distribution

次に、証明書を次の形式でダウンロードするには、キーチェーンに移動します。 .p12 ファイル。

そのためには、キーチェーンに移動してタブを切り替えます。 ログイン キーチェーンを開き、次にタブを選択します。 自分の証明書.

自分の証明書

次に、ダウンロードする証明書を選択します(証明書の日付で探してください)。

次に、証明書内の秘密鍵を右クリックして、 書き出す.

ファイル形式を選択 個人情報交換用証明書 (.p12).

これにより、証明書が .p12 ファイル。

ターミナルでファイルを開き、以下のコマンドで Base64 に変換してください:

base64 -i BUILD_CERTIFICATE.p12 | pbcopy

これがあなたの BUILD_CERTIFICATE_BASE64 secret になります。また、求められた場合は証明書のパスワードを入力してください。このパスワードがあなたの P12_PASSWORD secret です。

3. プロビジョニングプロファイル

開く Apple Developer で、正しいチームを選択します。

次に、 +

新しいプロファイルを作成

を選択します App Store Connect.

App Store Connect を選択

次に、正しいアプリを選択する必要があります。ワイルドカードを使用すると署名に失敗するため、注意してください。

適切なアプリを選択

以前に作成した正しい証明書を選択し(有効期限の日付を確認してください。今日と同じ月日になっているはずです)、次をクリックします: 続行.

適切な証明書を選択

最後にプロファイル名を入力し、次をクリックします: 生成.

この名前は、Fastlane 内でプロファイルの識別に使用されます(値として設定) APPLE_PROFILE_NAME.

プロファイルを生成

プロファイルは次の形式でダウンロードできます: .mobileprovision ファイル。

プロファイルをダウンロード

プロファイルを Base64 に変換し、シークレットとして保存してください(BUILD_PROVISION_PROFILE_BASE64).

base64 -i BUILD_PROVISION_PROFILE.mobileprovision | pbcopy

4. Fastlaneファイルのコピー

Fastlane は、モバイル開発でよくあるタスクを自動化するために作られた Ruby ライブラリです。Fastlane を使うと、通常 Android Studio で行うタスクを実行する一連の「アクション」をまとめたカスタム「レーン」を設定できます。Fastlane でできることはたくさんありますが、このチュートリアルでは主要なアクションをほんの一部だけ使います。

Capacitor/Ionic プロジェクトのルートに Fastlane フォルダを作成し、そこに Fastfile を追加します:

  • フォルダ: <project-root>/fastlane/
  • ファイル: <project-root>/fastlane/Fastfile

これは〜と同じ階層です package.json, capacitor.config.*、および ios/ フォルダです。その中には作成しないでください ios/App/.

platform :ios do
  desc 'Export ipa and submit to TestFlight'
  lane :beta do
    keychain_info = { keychain_name: "ios-build-#{Time.now.to_i}.keychain", keychain_password: SecureRandom.uuid }
    
    begin
      setup_signing(keychain_info)
      bump_build_number
      build_app_with_signing(keychain_info)
      submit_to_testflight
    ensure
      cleanup_keychain(keychain_info)
    end
  end

  private_lane :setup_signing do |options|
    create_keychain(
      name: options[:keychain_name],
      password: options[:keychain_password],
      unlock: true,
      timeout: 0,
      lock_when_sleeps: false, 
      add_to_search_list: true
    )
    import_cert(options)
    install_profile
    update_project_settings
  end

  lane :bump_build_number do
		file = File.read('../package.json')
		data_hash = JSON.parse(file)
		api_key = app_store_connect_api_key(
      key_id: ENV['APPLE_KEY_ID'],
      issuer_id: ENV['APPLE_ISSUER_ID'],
      key_content: ENV['APPLE_KEY_CONTENT'],
      is_key_content_base64: true,
      duration: 1200,
      in_house: false
    )
		build_num = app_store_build_number(
      api_key: api_key,
			app_identifier: ENV['BUNDLE_IDENTIFIER'],
			live: false
    )
		build_num = build_num + 1
		UI.message("Bumped build number to #{build_num}")
		increment_build_number(
			build_number: build_num,
			xcodeproj: "./ios/App/App.xcodeproj",
			skip_info_plist: true
		)
	end

  private_lane :import_cert do |options|
    cert_path = "#{Dir.tmpdir}/build_certificate.p12"
    File.write(cert_path, Base64.decode64(ENV['BUILD_CERTIFICATE_BASE64']))
    import_certificate(
      certificate_path: cert_path,
      certificate_password: ENV['P12_PASSWORD'] || "",
      keychain_name: options[:keychain_name],
      keychain_password: options[:keychain_password],
      log_output: true
    )
    File.delete(cert_path)
  end  
  
  private_lane :cleanup_keychain do |options|
    delete_keychain(
      name: options[:keychain_name]
    )
  end  

  private_lane :install_profile do
    profile_path = "#{Dir.tmpdir}/build_pp.mobileprovision"
    File.write(profile_path, Base64.decode64(ENV['BUILD_PROVISION_PROFILE_BASE64']))
    UI.user_error!("Failed to create provisioning profile at #{profile_path}") unless File.exist?(profile_path)
    ENV['PROVISIONING_PROFILE_PATH'] = profile_path
    install_provisioning_profile(path: profile_path)
    File.delete(profile_path)
  end

  private_lane :update_project_settings do
    update_code_signing_settings(
      use_automatic_signing: false,
      path: "./ios/App/App.xcodeproj",
      code_sign_identity: "iPhone Distribution",
      profile_name: ENV['APPLE_PROFILE_NAME'],
      bundle_identifier: ENV['BUNDLE_IDENTIFIER'],
      team_id: ENV['APP_STORE_CONNECT_TEAM_ID']
    )
    update_project_team(
      path: "./ios/App/App.xcodeproj",
      teamid: ENV['APP_STORE_CONNECT_TEAM_ID']
    )
  end

  private_lane :build_app_with_signing do |options|
    unlock_keychain(
      path: options[:keychain_name],
      password: options[:keychain_password],
      set_default: false
    )
    build_app(
      workspace: "./ios/App/App.xcworkspace",
      scheme: "App",
      configuration: "Release",
      export_method: "app-store",
      output_name: "App.ipa",
      export_options: {
        provisioningProfiles: {
          ENV['BUNDLE_IDENTIFIER'] => ENV['APPLE_PROFILE_NAME']
        }
      },
      xcargs: "-verbose",
      buildlog_path: "./build_logs",
      export_xcargs: "-allowProvisioningUpdates",
    )
  end   

  private_lane :submit_to_testflight do
    api_key = app_store_connect_api_key(
      key_id: ENV['APPLE_KEY_ID'],
      issuer_id: ENV['APPLE_ISSUER_ID'],
      key_content: ENV['APPLE_KEY_CONTENT'],
      is_key_content_base64: true,
      duration: 1200,
      in_house: false
    )
    pilot(
      api_key: api_key,
      skip_waiting_for_build_processing: true,
      skip_submission: true,
      distribute_external: false,
      notify_external_testers: false,
      ipa: "./App.ipa"
    )
  end
end

5. シークレットの設定

GitHub Actionsでは、次のステップで設定するリポジトリのシークレットを使用します。ローカルの .env ファイルは、自身のマシンからFastlaneを実行またはテストしたい場合にのみ必要です。

ローカルでテストするには、 <project-root>/fastlane/.env の隣に作成してください Fastfile。このファイルはコミットしないでください。先に fastlane/.env あなたの .gitignore を追加するか、既に無視されていることを確認してください。以下に例を示します:

APP_STORE_CONNECT_TEAM_ID=UVTJ336J2D
BUNDLE_IDENTIFIER=ee.forgr.testfastlane
# See previous section for these secrets
BUILD_CERTIFICATE_BASE64=
BUILD_PROVISION_PROFILE_BASE64=
APPLE_KEY_ID=
APPLE_ISSUER_ID=
APPLE_KEY_CONTENT=
P12_PASSWORD=
APPLE_PROFILE_NAME=

APP_STORE_CONNECT_TEAM_ID の取得方法

以下に移動します: デベロッパーセンター までスクロールし、 Membership details セクション。 Team ID に設定する値は、 APP_STORE_CONNECT_TEAM_ID secret です。

app-store-connect-team-id

BUNDLE_IDENTIFIER の取得方法

  1. Xcode を開く
  2. をダブルクリックし、 App プロジェクトナビゲーターで
  3. 次に、タブをクリックします Signing and Capabilities
  4. 以下の値をコピーしてください: Bundle identifier。これは、次の項目に設定する必要がある値です: BUNDLE_IDENTIFIER secret です。
bundle-identifier-xcode

6. ビルド処理

GitHub Actionsでは、 CI/CD ワークフローの実行に CI/CDワークフローの実行に使用してきたものです。私の経験では、App Store Connectでビルドが処理されるまで約10〜15分かかります。

プライベートプロジェクトの場合、1 ビルドあたりの推定コストは最大で $0.08/分 x 15分 = $1.2、プロジェクトの設定や依存関係によっては、それ以上かかる場合もあります。

プライベートプロジェクトのコストが気になる場合は、以下を設定できます: skip_waiting_for_build_processing まで true。App Store Connect のビルド処理完了を待たずにビルド時間を節約できます。

ただし、トレードオフがあります。ビルドをユーザーに配布する前に、App Store Connect でアプリのコンプライアンス情報を手動で更新する必要があります。

この最適化は、ビルド時間に料金がかかるプライベートプロジェクトで主に役立ちます。パブリック/無料プロジェクトではビルド時間が無料なので、この設定を有効にする必要はありません。詳細は GitHub の 料金ページ を参照してください。

7. GitHub Actions のセットアップ

GitHub のシークレットを設定

以下からシークレットをコピーしてください: .env ファイルを作成し、GitHub リポジトリのシークレットに貼り付けてください。

以下に移動します: 設定 > Secrets と変数 > アクション > 新しいリポジトリ Secret

github-secrets

2. BUILD_CERTIFICATE_BASE64 - Base64エンコードされた証明書

3. BUILD_PROVISION_PROFILE_BASE64 - Base64エンコードされたプロビジョニングプロファイル

4. BUNDLE_IDENTIFIER - アプリのBundle Identifier

5. APPLE_KEY_ID — App Store Connect API Key の 🔺Key ID

6. APPLE_ISSUER_ID — App Store Connect API Key の 🔺Issuer ID

7. APPLE_KEY_CONTENT — App Store Connect API キー 🔺 キーの内容 .p8, 確認してください

8. GitHub のワークフローファイルを設定

GitHub workflowディレクトリを作成します。

cd .github/workflows

その workflow フォルダ内に、 build-upload-ios.ymlという名前のファイルを作成し、以下を追加します。

name: Build source code on ios

on:
  push:
    tags:
      - '*'

jobs:
  build_ios:
    runs-on: macOS-latest
    steps:
      - uses: actions/checkout@v6
      - name: Set Node.js
        uses: actions/setup-node@v6
        with:
          node-version: 24
          cache: npm
      - name: Install dependencies
        id: install_code
        run: npm ci
      - name: Build
        id: build_code
        run: npm run build
      - uses: actions/cache@v5
        with:
          path: ios/App/Pods
          key: ${{ runner.os }}-pods-${{ hashFiles('**/Podfile.lock') }}
          restore-keys: |
            ${{ runner.os }}-pods-
      - name: Sync
        id: sync_code
        run: npx cap sync
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: '3.0'
          bundler-cache: true
      - uses: maierj/fastlane-action@v3.1.0
        env:
          APP_STORE_CONNECT_TEAM_ID: ${{ secrets.APP_STORE_CONNECT_TEAM_ID }}
          BUNDLE_IDENTIFIER: ${{ secrets.BUNDLE_IDENTIFIER }}
          BUILD_CERTIFICATE_BASE64: ${{ secrets.BUILD_CERTIFICATE_BASE64 }}
          BUILD_PROVISION_PROFILE_BASE64: ${{ secrets.BUILD_PROVISION_PROFILE_BASE64 }}
          APPLE_KEY_ID: ${{ secrets.APPLE_KEY_ID }}
          APPLE_ISSUER_ID: ${{ secrets.APPLE_ISSUER_ID }}
          APPLE_KEY_CONTENT: ${{ secrets.APPLE_KEY_CONTENT }}
          P12_PASSWORD: ${{ secrets.P12_PASSWORD }}
          APPLE_PROFILE_NAME: ${{ secrets.APPLE_PROFILE_NAME }}
        with:
          lane: ios beta
      - name: Upload release bundle
        uses: actions/upload-artifact@v6
        with:
          name: ios-release
          path: ./App.ipa
          retention-days: 10

このworkflowは、各GitHubの後にトリガーされるように設定します。 タグを設定します、タグの自動化が必要な場合は、こちらを参照してください GitHub アクションによる自動ビルドとリリース してください。

その後、このワークフローが NodeJS の依存関係を取得してインストールし、JavaScript アプリをビルドします。

新しいコミットを送信するたびに、TestFlight でリリースがビルドされます。

アプリは Ionic を使用する必要はありません。Capacitor ベースであることだけが必須です。古い Cordova モジュールがあっても構いませんが、Capacitor JS プラグインを優先してください。

8. ワークフローをトリガーする

コミットを作成

コミットを 作成すると、リポジトリでアクティブなワークフローが表示されます。

ワークフローをトリガーする

ブランチに新しいコミットをプッシュして main または development ワークフローをトリガーします。

コミットから開始

数分後、App Store Connectのダッシュボードでビルドが利用可能になります。

TestFlight ダッシュボード

9. ローカルマシンからデプロイできますか?

はい、できます。しかもとても簡単です。

従来通り、Xcodeを使用してアプリのビルドと署名を行うことができます。

CI/CDセットアップガイド

代替 CI/CD プラットフォーム

Live Updates &amp; デプロイ

ありがとうございます

この記事は以下の記事に基づいています:

証明書付きの GitHub actions を使用して、Capacitor の自動 iOS ビルドを継続

使用している場合 証明書付き GitHub actions による Capacitor iOS 自動ビルド 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の実装詳細については。

Capacitor アプリ向けの Live Updates

Web レイヤーのバグが本番で発生したら、App Store の審査を何日も待たずに Capgo で修正を配信しましょう。ネイティブの変更は通常の審査フローに残したまま、ユーザーはバックグラウンドでアップデートを受け取れます。

最新のブログ記事

Capgoは、真にプロフェッショナルなモバイルアプリを作るために必要な最高のインサイトを提供します。