Gradle で Android アプリをテスターに配布する

App Distribution Gradle プラグインを使用すると、App Distribution を Android ビルドプロセスに統合できます。このプラグインを使用すると、アプリの build.gradle ファイルでテスターとリリースノートを指定して、アプリのさまざまなビルドタイプやバリアントを配布できます。

始める前に

まだ Firebase を Android プロジェクトに追加していない場合は追加します。

他の Firebase プロダクトを使用していない場合は、プロジェクトを作成してアプリを登録するだけでかまいません。ただし、今後追加のプロダクトを使用する場合は、上記のリンク先のページの手順をすべて完了してください。

手順 1. Android プロジェクトを設定する

  1. プロジェクト レベルの Gradle ファイル(通常は android/build.gradle)に、App Distribution プラグインをビルド スクリプトの依存関係として追加します。

    buildscript {
        repositories {
            // Check that you have Google's Maven repository (if not, add it).
            google()
            jcenter()
        }
        dependencies {
            // Add the App Distribution Gradle plugin
            classpath 'com.google.firebase:firebase-appdistribution-gradle:2.0.1'
        }
    }
    
  2. アプリレベルの Gradle ファイル(通常は android/app/build.gradle)で、Android プラグインの下に App Distribution プラグインを含めます。

    apply plugin: 'com.android.application'
    // ...
    
    // Apply the App Distribution Gradle plugin
    apply plugin: 'com.google.firebase.appdistribution'
    // ...
    
  3. 企業のプロキシやファイアウォールの背後では、App Distribution が配布を Firebase にアップロードできるように、次の Java システム プロパティを追加します。

    -Djavax.net.ssl.trustStore=/path/to/truststore -Djavax.net.ssl.trustStorePassword=password
    

手順 2. Firebase で認証する

fastlane プラグインを使用する前に、Firebase プロジェクトで認証する必要があります。これには次の 3 つの方法があります。

手順 3. 配布プロパティを構成する

  1. app/build.gradle ファイル内に firebaseAppDistribution セクションを 1 つ以上追加して App Distribution を構成します。ビルドタイプとプロダクト フレーバーを通じて App Distribution を構成できます。たとえば、release ビルドをテスターに配布するには、次のようにします。

    android {
    
        // ...
    
        buildTypes {
            release {
                firebaseAppDistribution {
                    releaseNotesFile="/path/to/releasenotes.txt"
                    testers="ali@example.com, bri@example.com, cal@example.com"
                }
            }
        }
    
        // ...
    }
    

    また、「デモ版」と「完全版」のプロダクト フレーバーがあり、それらの debug ビルドと release ビルドを配布するには、次のようにします。

    android {
    
        // ...
    
        buildTypes {
            debug {...}
            release {...}
        }
    
        flavorDimensions "version"
        productFlavors {
          demo {
              dimension "version"
              firebaseAppDistribution {
                  releaseNotes="Release notes for demo version"
                  testers="demo@testers.com"
              }
          }
          full {
              dimension "version"
              firebaseAppDistribution {
                  releaseNotes="Release notes for full version"
                  testers="full@testers.com"
              }
          }
        }
    
        // ...
    }
    

次のパラメータを使用して、App Distribution を構成します。

App Distribution ビルド パラメータ
appId

アプリの Firebase アプリ ID。Google サービスの Gradle プラグインがインストールされていない場合にのみ必須です。アプリ ID は、google-services.json ファイルまたは Firebase コンソールの全般設定ページで確認できます。build.gradle ファイル内の値は、google-services プラグインの出力値よりも優先されます。

serviceCredentialsFile

サービス アカウントの秘密鍵の JSON ファイルへのパス。サービス アカウント認証を使用する場合にのみ必要です。

apkPath

アップロードする APK ファイルの絶対パスまたは相対パス。指定しない場合、Gradle は APK 出力ディレクトリからファイルの場所を特定します。

releaseNotes または releaseNotesFile

このビルドのリリースノート。

リリースノートを直接指定することも、書式なしテキスト ファイルのパスを指定することもできます。

testers または testersFile

ビルドを配布するテスターのメールアドレス。

テスターは、メールアドレスのカンマ区切りのリストとして指定できます。


testers="ali@example.com, bri@example.com, cal@example.com"

メールアドレスのカンマ区切りリストを含むファイルへのパスを指定することもできます。


testersFile="/path/to/testers.txt"
groups または groupsFile

ビルドの配布先のテスター グループ(テスターを管理するをご覧ください)。グループはグループ エイリアスを使用して指定します。グループ エイリアスは、Firebase App Distribution コンソールの [テスター] タブにあります。

グループは、グループ エイリアスのカンマ区切りのリストとして指定できます。


groups="qa-team, android-testers"

グループ エイリアスのカンマ区切りリストを含むファイルへのパスを指定することもできます。


groupsFile="/path/to/tester-groups.txt"
stacktrace

ユーザー例外のスタックトレースを出力します。これは問題のデバッグに役立ちます。

手順 4. テスターにアプリを配布する

最後にテストアプリをパッケージ化し、テスターを招待します。プロジェクトの Gradle ラッパーを使用して assembleBUILD-VARIANTappDistributionUploadBUILD-VARIANT のターゲットをビルドします。BUILD-VARIANT は、前の手順で構成したオプションのプロダクト フレーバーとビルドタイプです。

たとえば、release ビルド バリアントを使用してアプリを配布するには、次のコマンドを実行します。

./gradlew assembleRelease appDistributionUploadRelease

または、Google アカウントで認証し、Gradle ビルドファイル内に認証情報を指定していない場合は、FIREBASE_TOKEN 変数を含めます。

export FIREBASE_TOKEN=1/a1b2c3d4e5f67890
./gradlew --stop // Only needed for environment variable changes
./gradlew assembleRelease appDistributionUploadRelease

アプリのテストに招待されていないテスターには招待メールが届きます(アプリのインストール手順については、テスター設定ガイドをご覧ください)。既存のテスターには、新しいビルドの準備ができていることを知らせるメールが届きます。

プロダクト フレーバーの詳細については、ビルド バリアントの構成をご覧ください。