Вы можете интегрировать App Distribution в процесс сборки Android с помощью плагина App Distribution Gradle. Плагин позволяет вам указать тестировщиков и заметки о выпуске в файле Gradle вашего приложения, что позволяет вам настраивать дистрибутивы для различных типов сборки и вариантов вашего приложения.
В этом руководстве описывается, как распространять APK-файлы среди тестировщиков с помощью плагина App Distribution Gradle.
Прежде чем начать
Если вы еще этого не сделали, добавьте Firebase в свой проект Android .
Если вы не используете другие продукты Firebase, вам нужно только создать проект и зарегистрировать свое приложение. Однако, если вы решите использовать дополнительные продукты в будущем, обязательно выполните все шаги на странице, ссылка на которую приведена выше.
Шаг 1. Настройте свой Android-проект
В файле Gradle корневого уровня (уровня проекта) (
<project>/build.gradle.kts
или<project>/build.gradle
) добавьте плагин App Distribution Gradle в качестве зависимости: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.2" 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.2' apply false // Add the dependency for the App Distribution Gradle plugin id 'com.google.firebase.appdistribution' version '5.1.1' apply false }
В файле Gradle вашего модуля (уровня приложения) (обычно
<project>/<app-module>/build.gradle.kts
или<project>/<app-module>/build.gradle
) добавьте плагин 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' }
Если вы находитесь за корпоративным прокси-сервером или брандмауэром, добавьте следующее системное свойство Java , которое позволит App Distribution загружать ваши дистрибутивы в Firebase:
-Djavax.net.ssl.trustStore=/path/to/truststore -Djavax.net.ssl.trustStorePassword=password
Шаг 2. Аутентификация с помощью Firebase
Прежде чем использовать плагин Gradle, необходимо сначала пройти аутентификацию в проекте Firebase одним из следующих способов. По умолчанию плагин Gradle ищет учетные данные из Firebase CLI, если не используется никакой другой метод аутентификации.
Аутентификация с помощью учетной записи службы позволяет гибко использовать плагин с вашей системой непрерывной интеграции (CI). Существует два способа предоставления учетных данных учетной записи службы:
- Передайте файл ключа учетной записи службы в
build.gradle
. Этот метод может оказаться удобным, если у вас уже есть файл ключа учетной записи службы в вашей среде сборки. - Установите переменную среды
GOOGLE_APPLICATION_CREDENTIALS
так, чтобы она указывала на файл ключа учетной записи службы. Вы можете предпочесть этот метод, если у вас уже есть настроенные учетные данные приложения по умолчанию (ADC) для другой службы Google (например, Google Cloud ).
Для аутентификации с использованием учетных данных сервисной учетной записи:
- В консоли Google Cloud выберите свой проект и создайте новую учетную запись службы.
- Добавьте роль администратора Firebase App Distribution .
- Создайте закрытый ключ json и переместите его в место, доступное для вашей среды сборки. Обязательно сохраните этот файл в безопасном месте , так как он предоставляет администратору доступ к App Distribution в вашем проекте Firebase.
- Пропустите этот шаг, если вы создали свое приложение после 20 сентября 2019 г.: в консоли API Google включите API Firebase App Distribution . При появлении запроса выберите проект с тем же именем, что и у вашего проекта Firebase.
Укажите или найдите данные вашей учетной записи службы:
- Чтобы передать Gradle ключ учетной записи службы, в файле
build.gradle
задайте для свойстваserviceCredentialsFile
файл JSON с закрытым ключом. Чтобы найти свои учетные данные с помощью ADC, установите переменную среды
GOOGLE_APPLICATION_CREDENTIALS
на путь к файлу JSON закрытого ключа. Например:export GOOGLE_APPLICATION_CREDENTIALS=/absolute/path/to/credentials/file.json
Дополнительную информацию об аутентификации с помощью ADC см. в разделе Предоставление учетных данных приложению.
- Чтобы передать Gradle ключ учетной записи службы, в файле
Инструкции по аутентификации вашего проекта см. в разделе Вход с помощью Firebase CLI.
Шаг 3. Настройте свойства вашего дистрибутива
В файле Gradle вашего модуля (уровня приложения) (обычно <project>/<app-module>/build.gradle.kts
или <project>/<app-module>/build.gradle
) настройте App Distribution , добавив как минимум один раздел firebaseAppDistribution
.
Например, чтобы распространить release
сборку среди тестировщиков, следуйте этим инструкциям:
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" } } } // ... }
Вы можете настроить App Distribution для типов сборки и вариантов продукта .
Например, чтобы распространять debug
и release
сборки в «демо» и «полной» версиях продукта, следуйте этим инструкциям:
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" } } } // ... }
Для настройки распределения используйте следующие параметры:
Параметры сборки App Distribution | |
---|---|
appId | Firebase App ID вашего приложения. Требуется только если у вас не установлен плагин Google Services Gradle. Вы можете найти App ID в файле appId="1:1234567890:android:321abc456def7890" |
serviceCredentialsFile | Путь к файлу JSON закрытого ключа вашего сервисного аккаунта. Требуется только если вы используете аутентификацию сервисного аккаунта. |
artifactType | Указывает тип файла вашего приложения. Может быть установлен на |
artifactPath | Абсолютный путь к APK- или AAB-файлу, который вы хотите загрузить. |
releaseNotes или releaseNotesFile | Примечания к выпуску этой сборки. Вы можете указать заметки о выпуске напрямую или путь к текстовому файлу. |
testers или testersFile | Адреса электронной почты тестировщиков, которым вы хотите распространить сборки. Вы можете указать тестировщиков в виде списка адресов электронной почты, разделенных запятыми: testers="ali@example.com, bri@example.com, cal@example.com" Или вы можете указать путь к файлу, содержащему список адресов электронной почты, разделенных запятыми: testersFile="/path/to/testers.txt" |
groups или groupsFile | Группы тестировщиков, которым вы хотите распределить сборки (см. Управление тестерами ). Группы указываются с помощью Вы можете указать группы в виде списка псевдонимов групп, разделенных запятыми: groups="qa-team, android-testers" Или вы можете указать путь к файлу, содержащему список псевдонимов групп, разделенных запятыми: groupsFile="/path/to/tester-groups.txt" |
testDevices или testDevicesFile | Следующие типы дистрибутивов являются частью функции автоматического тестирования бета-версии . Тестовые устройства, на которые вы хотите распространять сборки (см. Автоматизированные тесты ). Вы можете указать тестовые устройства в виде списка спецификаций устройств, разделенных точкой с запятой: testDevices="model=shiba,version=34,locale=en,orientation=portrait;model=b0q,version=33,locale=en,orientation=portrait" Или вы можете указать путь к файлу, содержащему список спецификаций устройства, разделенных точкой с запятой: testDevicesFile="/path/to/testDevices.txt" |
testUsername | Имя пользователя для автоматического входа в систему, которое будет использоваться во время автоматизированных тестов . |
testPassword или testPasswordFile | Пароль для автоматического входа в систему, который будет использоваться во время автоматизированных тестов . Или вы можете указать путь к текстовому файлу, содержащему пароль: testPasswordFile="/path/to/testPassword.txt" |
testUsernameResource | Имя ресурса для поля имени пользователя для автоматического входа в систему, которое будет использоваться во время автоматизированных тестов . |
testPasswordResource | Имя ресурса для поля пароля для автоматического входа в систему, которое будет использоваться во время автоматизированных тестов . |
testNonBlocking | Запускайте автоматизированные тесты асинхронно. Посетите консоль Firebase для получения результатов автоматического теста. |
stacktrace | Выводит трассировку стека для пользовательских исключений. Это полезно при отладке проблем. |
Шаг 4. Распространите свое приложение среди тестировщиков
Наконец, чтобы упаковать ваше тестовое приложение и пригласить тестировщиков, создайте цели
BUILD-VARIANT
иappDistributionUpload BUILD-VARIANT
с помощью оболочки Gradle вашего проекта, где 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
Вы также можете переопределить значения, установленные в файле
build.gradle
, передав аргументы командной строки в форме--<property-name>=<property-value>
. Например:Чтобы загрузить отладочную сборку в App Distribution :
./gradlew bundleDebug appDistributionUploadDebug --artifactType="APK"
Чтобы пригласить дополнительных тестировщиков или удалить существующих тестировщиков из вашего проекта 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"
После добавления тестировщика в ваш проект Firebase вы можете добавлять его в отдельные релизы. Тестировщики, которые были удалены, больше не будут иметь доступа к релизам в вашем проекте, но могут по-прежнему сохранять доступ к вашим релизам в течение некоторого периода времени.
Вы также можете указать тестировщиков, используя
--file="/path/to/testers.txt"
вместо--emails
.Задачи
appDistributionAddTesters
иappDistributionRemoveTesters
также принимают следующие аргументы:projectNumber
: номер вашего проекта Firebase.serviceCredentialsFile
: Путь к файлу учетных данных службы Google. Это тот же аргумент, который используется действием загрузки.
Плагин Gradle выводит следующие ссылки после загрузки релиза. Эти ссылки помогают вам управлять бинарниками и гарантировать, что тестировщики и другие разработчики получат правильный релиз:
-
firebase_console_uri
- Ссылка на консоль Firebase , отображающую один релиз. Вы можете поделиться этой ссылкой с другими разработчиками в вашей организации. -
testing_uri
— ссылка на релиз в опыте тестировщика (собственное приложение Android), которая позволяет тестировщикам просматривать заметки о релизе и устанавливать приложение на свои устройства. Тестировщику необходим доступ к релизу, чтобы использовать ссылку. -
binary_download_uri
— подписанная ссылка, которая напрямую загружает и устанавливает двоичный файл приложения (файл APK или AAB). Ссылка истекает через один час.
После того, как вы распространите свою сборку, она станет доступна на панели App Distribution консоли Firebase в течение 150 дней (пяти месяцев). Когда до истечения срока действия сборки останется 30 дней, уведомление об истечении срока действия появится как в консоли, так и в списке сборок вашего тестировщика на его тестовом устройстве.
Тестировщики, которые не были приглашены для тестирования приложения, получают приглашения по электронной почте для начала работы, а существующие тестировщики получают уведомления по электронной почте о том, что новая сборка готова к тестированию (прочитайте руководство по настройке тестировщика для получения инструкций по установке тестового приложения). Вы можете отслеживать статус каждого тестировщика — приняли ли они приглашение и загрузили ли они приложение — в консоли Firebase .
У тестировщиков есть 30 дней, чтобы принять приглашение на тестирование приложения, прежде чем истечет его срок действия. Когда до истечения срока действия приглашения остается 5 дней, в консоли Firebase рядом с тестировщиком в релизе появляется уведомление об истечении срока действия. Приглашение можно продлить, отправив его повторно с помощью раскрывающегося меню в строке тестировщика.
Следующие шаги
Реализуйте функцию обратной связи в приложении , чтобы тестировщикам было проще отправлять отзывы о вашем приложении (включая снимки экрана).
Узнайте, как отображать внутри приложения оповещения для тестировщиков о том, что новые сборки вашего приложения доступны для установки.
Посетите лабораторию по кодированию Android App Bundle, чтобы узнать, как шаг за шагом распространять выпуски пакетов приложений.
Изучите передовой опыт распространения приложений Android среди тестировщиков QA с использованием CI/CD .