Vous pouvez intégrer App Distribution dans votre processus de construction Android à l'aide du plug-in App Distribution Gradle. Le plugin vous permet de spécifier vos testeurs et notes de version dans le fichier Gradle de votre application, vous permettant de configurer des distributions pour différents types de build et variantes de votre application.
Ce guide décrit comment distribuer des fichiers APK aux testeurs à l'aide du plug-in App Distribution Gradle.
Avant que tu commences
Si vous ne l'avez 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. Cependant, si vous décidez d'utiliser des produits supplémentaires à l'avenir, assurez-vous de suivre toutes les étapes de la page liée ci-dessus.
Étape 1. Configurez votre projet Android
Dans votre fichier Gradle au niveau racine (au niveau du projet) (
<project>/build.gradle.kts
ou<project>/build.gradle
), ajoutez le plug-in App Distribution Gradle en tant que dépendance :Kotlin
plugins { // ... id("com.android.application") version "7.2.0" apply false // Make sure that you have the Google services Gradle plugin dependency id("com.google.gms.google-services") version "4.3.15" apply false // Add the dependency for the App Distribution Gradle plugin id("com.google.firebase.appdistribution") version "4.0.0" apply false }
Groovy
plugins { // ... id 'com.android.application' version '7.2.0' apply false // Make sure that you have the Google services Gradle plugin dependency id 'com.google.gms.google-services' version '4.3.15' apply false // Add the dependency for the App Distribution Gradle plugin id 'com.google.firebase.appdistribution' version '4.0.0' apply false }
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 App Distribution Gradle :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' }
Si vous êtes derrière un proxy ou un pare-feu d'entreprise, ajoutez la propriété système Java suivante qui permet à App Distribution d'importer vos distributions sur Firebase :
-Djavax.net.ssl.trustStore=/path/to/truststore -Djavax.net.ssl.trustStorePassword=password
Étape 2. Authentifiez-vous avec Firebase
Avant de pouvoir utiliser le plugin 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 informations d'identification de la CLI Firebase si aucune autre méthode d'authentification n'est utilisée.
L'authentification avec un compte de service vous permet d'utiliser le plug-in de manière flexible avec votre système d'intégration continue (CI). Il existe deux manières de fournir les informations d'identification du compte de service :
- Transmettez le fichier de clé de votre compte de service à
build.gradle
. Vous pouvez trouver cette méthode pratique si vous avez déjà votre fichier de clé de compte de service dans votre environnement de génération. - Définissez la variable d'environnement
GOOGLE_APPLICATION_CREDENTIALS
pour qu'elle pointe vers le fichier de clé de votre compte de service. Vous pouvez préférer cette méthode si vous avez déjà configuré les informations d'identification par défaut de l'application (ADC) pour un autre service Google (par exemple, Google Cloud).
Pour vous authentifier à l'aide des identifiants du compte de service :
- Dans Google Cloud Console, sélectionnez votre projet et créez un nouveau compte de service.
- Ajoutez le rôle d'administrateur de distribution d'applications Firebase .
- Créez une clé json privée et déplacez-la vers un emplacement accessible à votre environnement de construction. Assurez-vous de conserver ce fichier dans un endroit sûr , car il accorde un accès administrateur à App Distribution dans votre projet Firebase.
- Ignorez cette étape si vous avez créé votre application après le 20 septembre 2019 : dans la console des API Google, activez l' API Firebase App Distribution. Lorsque vous y êtes invité, sélectionnez le projet portant le même nom que votre projet Firebase.
Fournissez ou recherchez les informations d'identification de votre compte de service :
- Pour transmettre Gradle votre clé de compte de service, dans votre fichier
build.gradle
, définissez la propriétéserviceCredentialsFile
sur le fichier JSON de clé privée. Pour localiser vos informations d'identification avec ADC, définissez la variable d'environnement
GOOGLE_APPLICATION_CREDENTIALS
sur le chemin du fichier JSON de clé privée. Par exemple :export GOOGLE_APPLICATION_CREDENTIALS=/absolute/path/to/credentials/file.json
Pour plus d'informations sur l'authentification avec ADC, consultez Fournir des informations d'identification à votre application.
- Pour transmettre Gradle votre clé de compte de service, dans votre fichier
Consultez Se connecter avec la CLI Firebase pour savoir comment authentifier votre projet.
Étape 3. Configurez 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 :
Kotlin
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" } } } // ... }
Groovy
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 build et les saveurs de produit .
Par exemple, pour distribuer les versions debug
et release
dans les versions de produit "démo" et "complètes", suivez ces instructions :
Kotlin
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" } } } // ... }
Groovy
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 :
Paramètres de construction de distribution d'applications | |
---|---|
appId | ID d'application Firebase de votre application. Requis uniquement si vous n'avez pas installé le plug-in Google Services Gradle. Vous pouvez trouver l'ID d'application dans le fichier appId="1:1234567890:android:321abc456def7890" |
serviceCredentialsFile | Chemin d'accès au fichier JSON de la clé privée de votre compte de service. Obligatoire uniquement si vous utilisez l'authentification du compte de service. |
artifactType | Spécifie le type de fichier de votre application. Peut être réglé sur |
artifactPath | Chemin absolu vers le fichier APK ou AAB que vous souhaitez télécharger. |
releaseNotes ou releaseNotesFile | Notes de version pour cette version. Vous pouvez spécifier directement les notes de version ou le chemin d'accès à un fichier texte brut. |
testers ou testersFile | Les adresses e-mail des testeurs auxquels vous souhaitez distribuer les builds. Vous pouvez spécifier les testeurs sous la forme d'une liste d'adresses e-mail séparées par des virgules : testers="ali@example.com, bri@example.com, cal@example.com" Vous pouvez également spécifier le chemin d'accès à un fichier contenant une liste d'adresses e-mail séparées par des virgules : testersFile="/path/to/testers.txt" |
groups ou groupsFile | Les groupes de testeurs auxquels vous souhaitez distribuer les builds (voir Gérer les testeurs ). Les groupes sont spécifiés à l'aide de Vous pouvez spécifier les groupes sous la forme d'une liste d'alias de groupe séparés par des virgules : groups="qa-team, android-testers" Vous pouvez également spécifier le chemin d'accès à un fichier contenant une liste d'alias de groupe séparés par des virgules : groupsFile="/path/to/tester-groups.txt" |
stacktrace | Imprime le stacktrace pour les exceptions utilisateur. Ceci est utile lors du débogage des problèmes. |
Étape 4. Distribuez votre application aux testeurs
Enfin, pour empaqueter votre application de test et inviter des testeurs, créez les cibles
BUILD-VARIANT
etappDistributionUpload BUILD-VARIANT
avec le wrapper Gradle de votre projet, où BUILD-VARIANT est la saveur de produit facultative et le type de build que vous avez configurés à l'étape précédente. Pour plus d'informations sur les variantes de produit, consultez Configurer les variantes de build .Par exemple, pour distribuer votre application à l'aide de la variante de version
release
, exécutez la commande suivante :./gradlew assembleRelease appDistributionUploadRelease
Ou, si vous vous êtes authentifié avec votre compte Google et que vous n'avez pas fourni d'informations d'identification dans votre fichier de build Gradle, incluez la variable
FIREBASE_TOKEN
:export FIREBASE_TOKEN=1/a1b2c3d4e5f67890 ./gradlew --stop // Only needed for environment variable changes ./gradlew assembleRelease appDistributionUploadRelease
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>
. Par exemple:Pour importer une version de débogage dans App Distribution :
./gradlew bundleDebug appDistributionUploadDebug --artifactType="APK"
Pour inviter des testeurs supplémentaires ou supprimer des testeurs 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 qui sont supprimés n'auront plus accès aux versions de votre projet, mais pourront toujours conserver l'accès à vos versions pendant un certain temps.
Vous pouvez également spécifier des testeurs en utilisant
--file="/path/to/testers.txt"
au lieu de--emails
.Les tâches
appDistributionAddTesters
etappDistributionRemoveTesters
acceptent également les arguments suivants :projectNumber
: votre numéro de projet Firebase.serviceCredentialsFile
: chemin d'accès à votre fichier d'informations d'identification de service Google. Il s'agit du même argument utilisé par l'action upload.
Le plugin Gradle génère les liens suivants après le téléchargement de la version. Ces liens vous aident à gérer les fichiers binaires et à vous assurer que les testeurs et autres développeurs disposent de la bonne version :
-
firebase_console_uri
- Un lien vers la console Firebase affichant une seule version. Vous pouvez partager ce lien avec d'autres développeurs de votre organisation. -
testing_uri
- Un lien vers la version dans l'expérience du testeur (application native Android) qui permet aux testeurs d'afficher les notes de version et d'installer l'application sur leur appareil. Le testeur doit avoir accès à la version pour utiliser le lien. -
binary_download_uri
- Un lien signé qui télécharge et installe directement le binaire de l'application (fichier APK ou AAB). Le lien expire après une heure.
Une fois que vous avez distribué votre build, il devient disponible dans le tableau de bord App Distribution de la console Firebase pendant 150 jours (cinq mois). Lorsque la version est à 30 jours de l'expiration, un avis d'expiration apparaît à la fois dans la console et dans la liste des versions 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, et les testeurs existants reçoivent des notifications par e-mail indiquant qu'une nouvelle version est prête à être testée (lisez le guide de configuration du testeur 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 ont 30 jours pour accepter une invitation à tester l'application avant son expiration. Lorsqu'une invitation est à 5 jours de l'expiration, un avis d'expiration apparaît dans la console Firebase à côté du testeur sur une version. Une invitation peut être renouvelée en la renvoyant à l'aide du menu déroulant sur la ligne du testeur.
Prochaines étapes
Mettez en place 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 pour vos testeurs lorsque de nouvelles versions de votre application sont disponibles à installer.
Consultez l' atelier de programmation d'Android App Bundle pour découvrir comment distribuer les versions d'App Bundle étape par étape.
Découvrez les meilleures pratiques pour distribuer des applications Android aux testeurs de contrôle qualité à l'aide de CI/CD .