Distribuer des applications Android aux testeurs à l'aide de Gradle

Vous pouvez intégrer App Distribution à votre processus de compilation Android à l'aide du plug-in Gradle App Distribution. Le plug-in vous permet de spécifier vos testeurs et vos notes de version dans le fichier Gradle de votre application. Vous pouvez ainsi configurer des distributions pour différents types de compilation et variantes de votre application.

Ce guide explique comment distribuer des APK aux testeurs à l'aide du plug-in Gradle App Distribution.

Avant de commencer

Si ce n'est pas déjà fait, ajoutez Firebase à votre projet Android.

Si vous n'utilisez aucun autre produit Firebase, il vous suffit de créer un projet et d'enregistrer votre application. Toutefois, si vous décidez d'utiliser d'autres produits à l'avenir, veillez à suivre toutes les étapes de la page indiquée ci-dessus.

Étape 1 : Configurer votre projet Android

1. Dans votre fichier Gradle au niveau de la racine (au niveau du projet) (<project>/build.gradle.kts ou <project>/build.gradle), ajoutez le plug-in Gradle App Distribution en tant que dépendance :

   Kotlin

   plugins {
       // ...
       id("com.android.application") version "7.3.0" apply false
   
       // Make sure that you have the Google services Gradle plugin dependency
       id("com.google.gms.google-services") version "4.4.3" apply false
   
       // Add the dependency for the App Distribution Gradle plugin
       id("com.google.firebase.appdistribution") version "5.1.1" apply false
   }

   Groovy

   plugins {
       // ...
       id 'com.android.application' version '7.3.0' apply false
   
       // Make sure that you have the Google services Gradle plugin dependency
       id 'com.google.gms.google-services' version '4.4.3' apply false
   
       // Add the dependency for the App Distribution Gradle plugin
       id 'com.google.firebase.appdistribution' version '5.1.1' apply false
   }

2. Dans le fichier Gradle de votre module (au niveau de l'application) (généralement <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle), ajoutez le plug-in Gradle App Distribution :

   Kotlin

   plugins {
     id("com.android.application")
   
     // Make sure that you have the Google services Gradle plugin
     id("com.google.gms.google-services")
   
     // Add the App Distribution Gradle plugin
     id("com.google.firebase.appdistribution")
   }

   Groovy

   plugins {
     id 'com.android.application'
   
     // Make sure that you have the Google services Gradle plugin
     id 'com.google.gms.google-services'
   
     // Add the App Distribution Gradle plugin
     id 'com.google.firebase.appdistribution'
   }

3. Si vous êtes protégé par un pare-feu ou un proxy d'entreprise, ajoutez la propriété système Java suivante qui permet à App Distribution d'importer vos distributions dans Firebase :

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

Étape 2 : S'authentifier avec Firebase

Avant de pouvoir utiliser le plug-in Gradle, vous devez d'abord vous authentifier auprès de votre projet Firebase de l'une des manières suivantes. Par défaut, le plug-in Gradle recherche les identifiants de la CLI Firebase si aucune autre méthode d'authentification n'est utilisée.

Étape 3 : Configurer vos propriétés de distribution

Dans le fichier Gradle de votre module (au niveau de l'application) (généralement <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle), configurez App Distribution en ajoutant au moins une section firebaseAppDistribution.

Par exemple, pour distribuer la version release aux testeurs, suivez ces instructions :

import com.google.firebase.appdistribution.gradle.firebaseAppDistribution

android {

  // ...

  buildTypes {
      getByName("release") {
          firebaseAppDistribution {
              artifactType = "APK"
              releaseNotesFile = "/path/to/releasenotes.txt"
              testers = "ali@example.com, bri@example.com, cal@example.com"
          }
      }
  }

  // ...
}

android {

  // ...

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

  // ...
}

Vous pouvez configurer App Distribution pour les types de compilation et les types de produit.

Par exemple, pour distribuer les versions debug et release dans les types de produit "demo" et "full", suivez ces instructions :

import com.google.firebase.appdistribution.gradle.firebaseAppDistribution

android {

  // ...

  buildTypes {
      getByName("debug") {...}
      getByName("release") {...}
  }

  flavorDimensions += "version"
  productFlavors {
      create("demo") {
          dimension = "version"
          firebaseAppDistribution {
              releaseNotes = "Release notes for demo version"
              testers = "demo@testers.com"
          }
      }
      create("full") {
          dimension = "version"
          firebaseAppDistribution {
              releaseNotes = "Release notes for full version"
              testers = "full@testers.com"
          }
      }
  }

  // ...
}

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"
          }
      }
  }

  // ...
}

Utilisez les paramètres suivants pour configurer la distribution :

appId="1:1234567890:android:321abc456def7890"

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

testersFile="/path/to/testers.txt"

groups="qa-team, android-testers"

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

testDevices="model=shiba,version=34,locale=en,orientation=portrait;model=b0q,version=33,locale=en,orientation=portrait"

testDevicesFile="/path/to/testDevices.txt"

testPasswordFile="/path/to/testPassword.txt"

Étape 4 : Distribuer votre application aux testeurs

1. Enfin, pour empaqueter votre application de test et inviter des testeurs, compilez les cibles BUILD-VARIANT et appDistributionUploadBUILD-VARIANT avec le wrapper Gradle de votre projet, où BUILD-VARIANT correspond au type de produit et au type de compilation facultatifs que vous avez configurés à l'étape précédente. Pour en savoir plus sur les types de produit, consultez Configurer des variantes de compilation.

   Par exemple, pour distribuer votre application à l'aide de la variante de compilation release, exécutez la commande suivante :

   ./gradlew assembleRelease appDistributionUploadRelease
   

   Si vous vous êtes authentifié avec votre compte Google et que vous n'avez pas fourni d'identifiants dans votre fichier de compilation Gradle, incluez la variable FIREBASE_TOKEN :

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

2. Vous pouvez également remplacer les valeurs définies dans votre fichier build.gradle en transmettant des arguments de ligne de commande sous la forme --<property-name>=<property-value>. Exemple :

   • Pour importer une version de débogage dans App Distribution :

     ./gradlew bundleDebug appDistributionUploadDebug
         --artifactType="APK"

   • Pour inviter d'autres testeurs ou en supprimer d'existants de votre projet Firebase :

     ./gradlew appDistributionAddTesters
         --projectNumber=<project_number>
         --emails="anothertester@email.com, moretesters@email.com"
     ./gradlew appDistributionRemoveTesters
         --projectNumber=<project_number>
         --emails="anothertester@email.com, moretesters@email.com"

     Une fois qu'un testeur a été ajouté à votre projet Firebase, vous pouvez l'ajouter à des versions individuelles. Les testeurs supprimés n'auront plus accès aux versions de votre projet, mais ils pourront peut-être y accéder pendant un certain temps.

   Vous pouvez également spécifier des testeurs à l'aide de --file="/path/to/testers.txt" au lieu de --emails.

   Les tâches appDistributionAddTesters et appDistributionRemoveTesters acceptent également les arguments suivants :

   • projectNumber : numéro de votre projet Firebase.

   • serviceCredentialsFile : chemin d'accès au fichier d'identifiants de votre service Google. Il s'agit du même argument que celui utilisé par l'action d'importation.

Le plug-in Gradle génère les liens suivants après l'importation de la version. Ces liens vous aident à gérer les binaires et à vous assurer que les testeurs et les autres développeurs disposent de la version appropriée :

• firebase_console_uri : lien vers la console Firebase affichant une seule version. Vous pouvez partager ce lien avec d'autres développeurs de votre organisation.
• testing_uri : lien vers la version dans l'expérience de testeur (application Android native) qui permet aux testeurs de consulter les notes de version et d'installer l'application sur leur appareil. Le testeur doit avoir accès à la version pour pouvoir utiliser le lien.
• binary_download_uri : lien signé qui télécharge et installe directement le fichier binaire de l'application (fichier APK ou AAB). Le lien expire au bout d'une heure.

Une fois votre build distribué, il devient disponible dans le tableau de bord App Distribution de la console Firebase pendant 150 jours (cinq mois). Lorsque la compilation arrive à 30 jours de son expiration, un avis d'expiration s'affiche à la fois dans la console et dans la liste des compilations de votre testeur sur son appareil de test.

Les testeurs qui n'ont pas été invités à tester l'application reçoivent des invitations par e-mail pour commencer. Les testeurs existants reçoivent des notifications par e-mail lorsqu'une nouvelle version est prête à être testée (consultez le guide de configuration des testeurs pour savoir comment installer l'application de test). Vous pouvez surveiller l'état de chaque testeur (s'il a accepté l'invitation et s'il a téléchargé l'application) dans la console Firebase.

Les testeurs disposent de 30 jours pour accepter une invitation à tester l'application avant qu'elle n'expire. Lorsqu'une invitation expire dans cinq jours, un avis d'expiration s'affiche dans la console Firebase à côté du testeur sur une version. Vous pouvez renouveler une invitation en la renvoyant à l'aide du menu déroulant sur la ligne du testeur.

Étapes suivantes

• Implémentez des commentaires dans l'application pour permettre aux testeurs d'envoyer facilement des commentaires sur votre application (y compris des captures d'écran).

• Découvrez comment afficher des alertes dans l'application à vos testeurs lorsque de nouvelles versions de votre application sont disponibles à l'installation.

• Consultez l'atelier de programmation Android App Bundle pour découvrir comment distribuer des versions d'app bundle, étape par étape.

• Découvrez les bonnes pratiques pour distribuer des applications Android aux testeurs QA à l'aide de la CI/CD.