App Distribution と fastlane でプレリリース版の iOS ビルドを迅速に配布

1. 始める前に

4cddd34bd261cea0.png

この Codelab では、Firebase App Distribution とその fastlane プラグインを使用して、iOS アプリをテスターに配信し、テストデバイスの UDID を収集してアプリのプロビジョニング プロファイルに登録する方法を学びます。これにより、アドホック ビルドをテスターに迅速に配布できるようになります。

学習内容

  • Firebase App Distribution と fastlane を使用してプレリリース版の iOS アプリ（アドホック）をアップロードしてテスターに配布する方法
  • テスターとして登録し、配布されたアプリをテストデバイスにダウンロードする方法。
  • App Distribution の fastlane プラグインを使用してテストデバイスの UDID をエクスポートし、テストデバイスをすばやく登録する方法
  • アプリのプロビジョニング プロファイルを更新し、配布用に再アップロードする方法

必要なもの

  • Google アカウント
  • XCode 11.7 以降がインストールされている Apple マシン
  • Xcode で構築されたアドホックのプレリリース iOS アプリ
  • 有料の Apple Developer アカウント
  • テスト用の物理 iOS デバイス。

iOS シミュレータ アプリは Codelab の大部分で機能しますが、リリースをダウンロードすることはできません。

App Distribution テスター ウェブアプリに [ダウンロード] ボタンが表示されていれば、セットアップは正常に機能しています。

2. 使ってみる

fastlane を設定する

App Distribution を fastlane と統合すると、アプリのプレリリース版ビルドの配布を自動化できます。App Distribution は fastlane 構成と統合します。

  1. fastlane をインストールして設定します。
  2. 設定中にプロジェクトのルート ディレクトリで fastlane init を実行し、[手動設定] を選択します。fastlane というサブディレクトリがあり、そこに Fastfile、Appfile、Pluginfile が含まれています。これらは fastlane を構成するために使用します。

Firebase CLI をインストールする

また、Firebase CLI のインストールも必要です。macOS または Linux を使用している場合は、次の cURL コマンドを実行します。

curl -sL https://firebase.tools | bash

Windows を使用している場合は、インストール手順を参照してスタンドアロン バイナリを取得するか、npm を介してインストールしてください。

CLI をインストールしたら、firebase --version を実行すると 12.0.0 以降のバージョンが報告されます。

$ firebase --version
12.0.0

3. fastlane でアプリをビルドする

アプリを作成する

  1. ./fastlane/Appfile. で fastlane のグローバル変数をいくつか設定します。アプリの ID と Apple ID を含めます。
app_identifier("<your app's bundle identifier>")
apple_id("<your Apple id>")
  1. 最初のレーンを作成し、./fastlane/Fastfile に次の行を追加して、fastlane の build_app アクション（gym とも呼ばれます）を使用してアプリをビルドします。
default_platform(:ios)

lane :build do
    build_app(export_method: "ad-hoc")
end
  1. 配布用にアプリに署名する。

この Codelab では、get_certificates（cert）を使用して独自の証明書とプロファイルを管理します。これにより、署名証明書がローカルで生成され、すべて macOS キーチェーンに保存されます。ただし、通常は fastlane sync_code_signing action（match とも呼ばれます）を使用してチームのコード署名証明書とプロファイルを安全に管理します。

lane :build do
    get_certificates()
    build_app(export_method: "ad-hoc")
end
  1. get_provisioning_profile アクション（sigh）を使用して、アプリのプロビジョニング プロファイルを設定します。これにより、アプリをテスターと共有できるようになります。
lane :build do
    get_certificates()
    get_provisioning_profile(adhoc: true)
    build_app(export_method: "ad-hoc")
end
  1. （省略可）アプリをこれまでに実行したことがない場合は、Apple Developer Console で次のコマンドを実行して、アプリを作成します。

$ fastlane produce --skip_itc

  1. 最後にレーンを実行してアプリをビルドします。

Apple ID、パスワード（キーチェーンに保存されているもの）、アプリのバンドル ID の入力を求められます。

$ fastlane build

問題が発生した場合は、fastlane のトラブルシューティング ガイドをご覧ください。

4. アプリを Firebase にアップロードする

作成したアプリを App Distribution にアップロードする準備が整いました。

Firebase プロジェクトを作成して設定する

  1. Firebase にログインします。
  2. Firebase コンソールで新しいプロジェクトを作成または追加し、プロジェクトに「UDID Export Codelab」という名前を付けます。

このプロジェクトでは Google アナリティクスを有効にする必要はありません。

  1. [プロジェクトの作成] をクリックします。

iOS アプリをプロジェクトに追加する

  1. iOS アイコンをクリックして新しい Firebase iOS アプリを作成し、アプリのバンドル ID を入力します。

9c26c130a6c42212.png

  1. 次の数ステップをスキップして、[コンソールに進む] をクリックします。SDK は後でアプリに追加します。

プロジェクトとアプリが [プロジェクトの概要] ページで使用できるようになりました。

66f79cc8a97fa8e9.png

App Distribution を有効にする

  1. [リリースとモニタリング] セクションで、[App Distribution] をクリックします。
  2. 規約に同意したら、[始める] をクリックしてアプリで App Distribution を有効にします。

460213326c2784ae.png

fastlane にディストリビューションを設定する

  1. iOS プロジェクトのルートから次のコマンドを実行して、App Distribution を fastlane 構成に追加します。

コマンドでオプションを求められた場合は、[Option 3: RubyGems.org] を選択します。

$ fastlane add_plugin firebase_app_distribution

  1. プラグインがインストールされていることを確認します。

$ fastlane

出力で、インストールされているプラグインのリストに fastlane-plugin-firebase_app_distribution と表示されます。

  1. プラグインがインストールされていることを確認したら、オプション 0 を選択してキャンセルします。

Firebase プロジェクトを認証する

fastlane プラグインを使用するには、まず Firebase プロジェクトを認証します。

  1. 次のコマンドを実行して、CLI を Google アカウントに接続します。

$ firebase login

  1. コマンドで認証リンクが出力されたら、ブラウザでリンクを開きます。
  2. プロンプトが表示されたら、Google アカウントにログインして Firebase プロジェクトへのアクセスを許可します。

アプリを配布する

これで、アプリを配信する準備が整いました。

  1. ./fastlane/Fastfile の先頭で、firebase_app_id という変数を定義します。<your_app_id> は、作成したアプリの Firebase アプリ ID に置き換えます（プロジェクトの設定ページで確認できます）。

Fastfile は Ruby で記述されているため、変数の定義には Ruby 構文を使用します。

firebase_app_id = "<your_app_id>"
  1. ビルドレーンを呼び出し、firebase_app_distribution アクションを使用してアプリを配布する distribute という新しいレーンを追加します。
lane :distribute do
    build
    firebase_app_distribution(
        app: firebase_app_id,
        release_notes: "Try out this app!",
    )
end
  1. 新しいレーンを実行してアプリをビルドし、ディストリビューションを作成します。

$ fastlane distribute

この時点で、Fastfile は次のようになります。

firebase_app_id = "<your Firebase app ID>"

default_platform(:ios)

lane :build do
    get_certificates()
    get_provisioning_profile(adhoc: true)
    build_app(export_method: "ad-hoc")
end

lane :distribute do
    build
    firebase_app_distribution(
        app: firebase_app_id,
        release_notes: "Try out this app!",
    )
end

Firebase コンソールを更新すると、アプリの新しいリリースが表示されます。

c59dc1a94de3bf3c.png

5. テスターにアプリをダウンロードしてもらう

テスターがアドホック ビルドのテストへの招待を承諾すると、UDID を共有する許可を求められます。同意した場合、App Distribution はデバイス情報を収集し、メールでデベロッパーに通知します。このセクションでは、ご自身をテスターとして追加し、配布したアプリのダウンロードとテストを行います。

ご自身をリリースのテスターとして追加する

  1. Fastfile の上部にある firebase_app_id で、テスターを保持する変数を作成します。この変数には、自分のメールアドレスと、その他の任意で試すメールアドレスを含めます。
firebase_app_id = "<your Firebase app ID>"
app_testers = [
  "your@email.com",
  "another@email.com",
]
  1. Ruby の Array#join メソッドを適用して、app_testers 配列をカンマ区切りの文字列に変換します。これは、testers パラメータが想定しています。次に、結果を firebase_app_distribution. の testers パラメータに渡します。
lane :distribute do
    build
    firebase_app_distribution(
        app: firebase_app_id,
        release_notes: "Try out this app!"
        testers: app_testers.join(","),
    )
end

この時点で、Fastfile は次のようになります。

firebase_app_id = "<your Firebase app ID>"
app_testers = [
  "your@email.com",
  "another@email.com",
]

default_platform(:ios)

lane :build do
    get_certificates()
    get_provisioning_profile(adhoc: true)
    build_app(export_method: "ad-hoc")
end

lane :distribute do
    build
    firebase_app_distribution(
        app: firebase_app_id,
        release_notes: "Try out this app!",
        testers: app_testers.join(","),
    )
end
  1. もう一度車線を走行します。

$ fastlane distribute

レーンを走ると、追加したテスターに App Distribution から、新しく利用可能になったリリースを通知する招待メールが届きます。これで、Firebase コンソールで、アプリのリリースに追加したテスターを確認できます。

2e0fc9603b868af8.png

メールアドレスを指定したため、アプリをテストするための招待メールが Firebase App Distribution から届きます。これで最初のテスターになります。以下の手順に沿って、テストデバイスでテスターとして設定します。

テストデバイスを登録する

テスターとして、テストに招待されたアプリのリリースにアクセスするには、テストデバイスで Google にログインする必要があります。テストビルドはアドホック リリースであるため、Firebase プロファイルをインストールしてテストデバイスを登録する必要があります。その後、デバイスのホーム画面に追加されたウェブクリップを使用して、App Distribution テスター ウェブアプリから利用可能になったリリースにアクセスできます。

  1. iOS のテストデバイスで、Firebase App Distribution から送信されたメールを開き、[使ってみる] リンクをタップします。必ず Safari でリンクを開いてください。
  2. App Distribution のテスター ウェブアプリが開いたら、表示されたページで Google アカウントでログインし、[招待に応じる] をタップします。

d833407de251b89f.png

  1. 招待されたリリースが表示されるようになりました。いずれかのリリースの下にある [デバイスを登録] をタップします。

fd141215e54a938d.png

  1. プロンプトが表示されたら、Firebase プロファイルをダウンロードし、設定アプリにインストールします。

プロファイルをインストールすると、Firebase に次の権限が付与されます。

  • デバイスの一意のデバイス ID（UDID）を収集して、テストデバイスを登録します。

Firebase プロジェクトのすべてのオーナーと編集者に、テストデバイスの UDID が記載されたメールが送信されます。

  • テストデバイスのホーム画面にウェブクリップをインストールします。このウェブクリップから App Distribution のテスター ウェブアプリが開き、すべてのテストアプリをインストールしてアクセスできます。

これで、App Distribution テスター ウェブアプリで、アプリのリリースにテストデバイスが登録されます。

fe93d649df25877.png

テストデバイスの UDID を Firebase と共有したら、デベロッパーとして再開できます。App Distribution ダッシュボードの [テスター] タブで、アプリのリリースの下にテスター情報が [承認済み] のステータスで表示されます。

7b9f665a63a384cf.png

次のセクションでは、デバイスの UDID をアプリのプロビジョニング プロファイルに追加してから、テストデバイスと連携するバージョンのアプリをビルドします。

テスター デバイスの UDID をエクスポートする

デベロッパーは、テストデバイスの UDID を含むメールが Firebase から届きます。App Distribution のオプションとして、Firebase コンソールから複数の新しいデバイスの UDID を未加工のテキスト ファイルとして直接エクスポートすることで、一度に複数の新しいデバイス UDID を簡単に収集できます。

  1. すべての UDID をエクスポートするには、[テスターとグループ] タブを開きます。

241a9936898a2fc0.png

  1. [Apple UDID をエクスポート] をクリックします。

bcf0c26c522d9b4e.png

このファイルには、テストデバイスの UDID を含める必要があります。

Device ID            Device Name                            Device Platform
1234567890     udid.codelab.tester@gmail.com - iPhone SE 2nd Gen        ios

UDID は、次のセクションで fastlane を使用してコマンドラインからエクスポートすることもできます。

6. アプリのプロビジョニング プロファイルを更新して再ビルドする

次に、テストデバイスの UDID をアプリのプロビジョニング プロファイルに追加し、デバイスで機能するバージョンのアプリを再ビルドして、新しいバージョンを配布します。

UDID エクスポート レーンを追加

  1. Fastfile の先頭に別の変数を追加し、テスターのデバイスの UDID をダウンロードするファイルパスを指定します。
firebase_app_id = "<your Firebase app ID>"
app_testers = [
  "your@email.com",
  "another@email.com",
]
tester_udids_file = "tester_udids.txt"
  1. コンソールで行ったのと同様に、App Distribution プラグインの UDID エクスポート アクションを使用してテスターの UDID をダウンロードする新しいレーンを設定します。
lane :download_udids do
    firebase_app_distribution_get_udids(
        app: firebase_app_id,
        output_file: tester_udids_file,
    )
end
  1. 次のレーンを実行して UDID をダウンロードします。

$ fastlane download_udids

  1. ダウンロードしたファイルを出力します。このファイルには、テストデバイスの UDID が含まれています。

$ cat tester_udids.txt

Apple Developer Console にデバイスを追加する

  1. Apple Developer Console でデバイスリストに UDID を追加するために次のレーンを作成します。これにより、fastlane の register_devices アクションを使用してプロビジョニング プロファイルに UDID を追加できます。
lane :add_new_devices do
    register_devices(devices_file: tester_udids_file)
end
  1. 次にレーンを実行します。

$ fastlane add_new_devices

Developer Console のデバイスリストに新しいデバイスが表示されます。

プロビジョニング プロファイルにデバイスを追加する

  1. build レーンのプロビジョニング プロファイルのステップに force 引数を追加して、ビルドのたびに新しいデバイスが選択されるようにします。
lane :build do
    get_certificates()
    get_provisioning_profile(adhoc: true, force: true)
    build_app(export_method: "ad-hoc")
end

ビルドとアップロードのためのレーンを再実行する

次に、デバイスをプロビジョニング プロファイルに追加し、アプリを再ビルドして配布するために、distribute レーンを新しいレーンで更新します。

  1. distribute から新しいレーンを呼び出します。
lane :distribute do
    download_udids
    add_new_devices
    build
    firebase_app_distribution(
        app: "1:123456789:ios:abcd1234",
        release_notes: "Try out this app!"
        testers: app_testers.join(","),
    )
end
  1. distribute レーンを実行します。

$ fastlane distribute

この時点で、Fastfile は次のようになります。

firebase_app_id = "<your Firebase app ID>"
app_testers = [
  "your@email.com",
  "another@email.com",
]
tester_udids_file = "tester_udids.txt"

default_platform(:ios)

lane :build do
    get_certificates()
    get_provisioning_profile(adhoc: true, force: true)
    build_app(export_method: "ad-hoc")
end

lane :distribute do
    download_udids
    add_new_devices
    build
    firebase_app_distribution(
        app: firebase_app_id,
        release_notes: "Try out this app!",
        testers: app_testers.join(","),
    )
end

lane :download_udids do
    firebase_app_distribution_get_udids(
        app: firebase_app_id,
        output_file: tester_udids_file,
    )
end

lane :add_new_devices do
    register_devices(devices_file: tester_udids_file)
end

テストデバイスからリリースをダウンロードする

アプリにテストデバイスの UDID が追加されたので、これをテストデバイスにインストールできます。

e275f73d57cc8fb1.png

  1. テストデバイスで、メール内のリンクまたはデバイスのホーム画面のアイコンを使用して、App Distribution テスター ウェブアプリに戻ります。

UDID Codelab アプリに移動すると、リリースをダウンロードする準備ができていることを確認できます。

dad6d03b6ad78746.png

  1. 実機を使用している場合は、[ダウンロード] をタップし、アプリをインストールして実行します。

7. 完了

これで、プレリリース版のテストプロセスを自動化する App Distribution と fastlane を構成しました。これからは、fastlane distribute コマンド 1 つを実行するだけで、他のテスターを招待したり、テスターの UDID をアプリに追加したりできます。

そのため、テスターから UDID を個別に収集したり、Apple Developer Console にアクセスしてデバイスリストを更新したり、プロファイルをプロビジョニングしたりする必要がなくなります。Xcode を開く必要さえありません。

このワークフローは、継続的インテグレーション環境で毎時または毎日実行するように簡単に設定できます。

関連情報