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

Codemagic による Capacitor iOS 自動ビルド

CodemagicでiOS IonicアプリのCI/CDパイプラインを5分で構築する方法 (2024年版)

Codemagic による Capacitor iOS ビルドの自動化 Capgo ブログ イラスト

Codemagicを使用したiOSの継続的デリバリー

前提条件

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

  • iOS Developer Programへの登録
  • 読みたくなる 😆…

料金に関する重要事項

Codemagic Action の料金

https://codemagic.io/pricing/

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

🔴 要件と価格を確認したところで、続けましょう…

📣 本記事では、iTunes Connect でアプリを作成済みで、Apple エコシステムの証明書も取得済みであることを前提としています。設定はすべて Codemagic が行います。

詳しく見ていきましょう 🤿

この記事の手順

  1. Codemagic で App Store Connect API を使う
  2. 要件
  3. App Store Connect API Keyの作成
  4. App Store Connect API Key の使用
  5. Fastlaneファイルをコピー
  6. Codemagic の設定

1. CodemagicでApp Store Connect API を使う

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

matchを使い始めるには、既存の証明書を失効させる必要があります。でも心配いりません。新しい証明書はすぐに取得できます。

要件

App Store Connect の API を使用するには、Codemagic には 3 つのこと。

  1. Issuer ID。
  2. Key ID
  3. KeyファイルまたはKeyの内容

App Store Connect API Keyの作成

キーを生成するには、App Store ConnectのAdmin権限が必要です。権限がない場合は、担当者にこの記事を案内し、以下の手順に従ってもらってください。

1 — ログイン App Store Connect.

2 — 選択 ユーザーとアクセス.

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

3 — API Keys タブを選択します。

App Store Connect API キー

4 — Generate API Key、または追加 (+) ボタンをクリックします。

App Store Connect API キーの作成

5 — キーの名前を入力し、アクセスレベルを選択します。次を選択することを推奨します App Manager アクセス権。Apple Developer Program のロール権限についてはこちら こちら

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

6 — 「Generate」をクリック。

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

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

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

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

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

CodemagicにApp Store ConnectのAPIキーを追加する

  1. CodemagicのTeam設定を開きます Team integrationsを選択します チームを開きます codeのsigning identitiesを選択します codeのsigning identitiesを選択します そして証明書をアップロードします 証明書をアップロード

  2. 次をクリックします: キーを追加 ボタンをクリックしてください。

  3. 入力してください App Store Connect API key name. これは、後でアプリケーション設定でこのキーを参照するときに使う、人間が読める名前です。

  4. 入力してください Issuer ID と Key ID 値。

  5. 次をクリックします: .p8ファイルを選択 または、先ほどダウンロードしたApp Store ConnectのAPIキーをアップロードするには、ファイルをドラッグ&ドロップしてください。

  6. クリック 保存.

これでApp Store ConnectのAPIキーを使用してCodemagicを管理できるようになりました。完璧です!

2. 証明書とプロビジョニングプロファイルの作成

証明書

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

Code の署名ID

次をクリックします: 証明書の管理 > + を選択し、 Apple Distribution.

Apple Distribution

その後、新しい証明書を作成できます。

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

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

自分の証明書

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

次に、証明書を右クリックして選択します。 書き出す.

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

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

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

開く Apple Developer としてダウンロードされ、適切なチームを選択します。

次に、 +

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

を選択 App Store Connect.

App Store Connect を選択

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

適切なアプリを選択

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

適切な証明書を選択

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

この名前は、Codemagic でプロファイルを識別するために使用されます。

プロファイルを生成

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

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

Code 署名証明書の追加

Codemagicでは、証明書とその使用に必要な秘密鍵の両方を含むPKCS#12アーカイブとして、code署名証明書をアップロードできます。アップロード時に、Codemagicは証明書のパスワード(パスワードで保護されている場合)と一意の 参照名の入力を求めます。この名前は、 codemagic.yaml 設定で特定のファイルを取得するために使用できます。

  • 証明書をアップロード
  • 新しい証明書を生成
  • Developer Portalから取得
  1. Codemagicのチーム設定を開き、以下に移動します: codemagic.yamlの設定 > Code の署名ID.
  2. 開く iOS 証明書 タブと比較してください。
  3. クリックして証明書ファイルをアップロード .p12 または .pem ファイルを選択 または、指定された領域にドラッグ&ドロップしてください。
  4. 入力してください 証明書のパスワード を選択してください 参照名.
  5. クリック 証明書の追加

プロビジョニングプロファイルの追加

Codemagic では、アプリケーションで使用するためのプロビジョニングプロファイルのアップロード、または Apple Developer Portal からのプロファイル取得が可能です。

各プロファイルについて、タイプ、チーム、Bundle ID、有効期限が表示されます。また、Codemagic は、Code の署名アイデンティティに一致する code 署名証明書が Code の署名アイデンティティに存在するかどうか( 証明書 フィールドに緑のチェックマークが表示される)を通知します。

3. Codemagic のセットアップ

Codemagic シークレットの構成

〜の値がどこから来ているのか、疑問に思ったことはありませんか? ENV 実はもう秘密ではありません。プロジェクトの secret から取得しています。🤦

4. Codemagic ワークフローファイルの構成

名前のファイルを作成します codemagic.yml プロジェクトのルートに配置し、以下の内容を追加します。

workflows:
  ionic-capacitor-ios-workflow:
    name: Capacitor iOS Workflow
    max_build_duration: 120
    instance_type: mac_mini_m1
    integrations:
      app_store_connect: CodeMagic
    environment:
      ios_signing:
        distribution_type: app_store
        bundle_identifier: YOUR_BUNDLE_IDENTIFIER
      vars:
        XCODE_WORKSPACE: ios/App/App.xcworkspace
        XCODE_SCHEME: App
        APP_STORE_APP_ID: YOUR_APP_STORE_APP_ID
      node: v20.14.0
      xcode: 15.4
      cocoapods: default
    triggering:
      events:
        - tag
      tag_patterns:
        - pattern: '*'
          include: true
    scripts:
      - name: Install dependencies
        script: |
          npm install
      - name: Cocoapods installation
        script: |
          cd ios/App && pod install
      - name: Update dependencies and copy web assets to native project
        script: |
          npm run build
          npx cap sync ios
      - name: Set up code signing settings on Xcode project
        script: |
          xcode-project use-profiles
      - name: Increment build number
        script: |
          cd $CM_BUILD_DIR/ios/App
          LATEST_BUILD_NUMBER=$(app-store-connect get-latest-app-store-build-number "$APP_ID")
          agvtool new-version -all $(($LATEST_BUILD_NUMBER + 1))
      - name: Build ipa for distribution
        script: |
          xcode-project build-ipa \
            --workspace "$XCODE_WORKSPACE" \
            --scheme "$XCODE_SCHEME"
    artifacts:
      - build/ios/ipa/*.ipa
      - /tmp/xcodebuild_logs/*.log
      - $HOME/Library/Developer/Xcode/DerivedData/**/Build/**/*.app
      - $HOME/Library/Developer/Xcode/DerivedData/**/Build/**/*.dSYM
    publishing:
      email:
        recipients:
          - YOUR_EMAIL
        notify:
          success: true # To not receive a notification when a build succeeds
          failure: false # To not receive a notification when a build fails
      app_store_connect:
        auth: integration
        # Configuration related to TestFlight (optional)
        # Note: This action is performed during post-processing.
        submit_to_testflight: true
        # Configuration related to App Store (optional)
        # Note: This action is performed during post-processing.
        submit_to_app_store: false

このワークフローは、手動または各 GitHub の後にトリガーされるべきです タグを設定します。タグの自動化が必要な場合は、こちらを参照してください GitHub actions を用いた自動ビルドとリリース してください。

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

新しいタグを送るたびに、TestFlight でリリースがビルドされます。

アプリは Ionic を使用する必要はありません。必須なのは Capacitor ベースのみです。古い Cordova モジュールがあっても構いませんが、Capacitor JS プラグインの使用を推奨します。

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

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

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

コミットから開始

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

TestFlight ダッシュボード

手動で開始

ワークフローを手動で開始できます。

まずビルドしたいアプリを選択し、次にクリック: 新規ビルドを開始.

アプリを選択

次に、ビルドしたいブランチを選択します。

ブランチを選択

そしてクリック: 新規ビルドを開始.

次にビルド一覧へ移動します

ビルド一覧

ビルドをクリックして結果を確認します。

ビルド結果

ローカルマシンからデプロイ可能

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

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

ありがとうございます

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

Codemagicによる自動 Capacitor iOS buildから次のステップへ

使用している場合 Codemagic による 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は、真にプロフェッショナルなモバイルアプリを作るために必要な最高のインサイトを提供します。