You can integrate App Distribution into your Android build process using the App Distribution Gradle plugin. The plugin lets you specify your testers and release notes in your app's Gradle file, letting you configure distributions for different build types and variants of your app.
В этом руководстве описано, как распространять APK-файлы среди тестировщиков с помощью плагина Gradle App Distribution .
Прежде чем начать
Если вы еще этого не сделали, добавьте 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.4" apply false // Add the dependency for the App Distribution Gradle plugin id("com.google.firebase.appdistribution") version "5.2.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.4' apply false // Add the dependency for the App Distribution Gradle plugin id 'com.google.firebase.appdistribution' version '5.2.1' apply false }
В файл Gradle вашего модуля (уровня приложения) (обычно
<project>/<app-module>/build.gradle.ktsили<project>/<app-module>/build.gradle) добавьте плагин 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' }
Если вы используете корпоративный прокси-сервер или брандмауэр, добавьте следующее системное свойство Java , которое позволит App Distribution загружать ваши дистрибутивы в Firebase:
-Djavax.net.ssl.trustStore=/path/to/truststore -Djavax.net.ssl.trustStorePassword=password
Шаг 2. Аутентификация с помощью Firebase.
Before you can use the Gradle plugin, you must first authenticate with your Firebase project in one of the following ways. By default, the Gradle plugin looks for credentials from the Firebase CLI if no other authentication method is used.
Аутентификация с помощью сервисной учетной записи позволяет гибко использовать плагин с вашей системой непрерывной интеграции (CI). Существует два способа предоставления учетных данных сервисной учетной записи:
- Передайте файл ключа вашей учетной записи службы в файл
build.gradle. Этот метод может оказаться удобным, если файл ключа вашей учетной записи службы уже находится в вашей среде сборки. - Установите переменную среды
GOOGLE_APPLICATION_CREDENTIALSтак, чтобы она указывала на файл ключа вашей учетной записи службы. Этот метод может быть предпочтительнее, если у вас уже настроены учетные данные приложения по умолчанию (ADC) для другой службы Google (например, Google Cloud ).
Для аутентификации с использованием учетных данных сервисной учетной записи:
- В консоли Google Cloud выберите свой проект и создайте новую учетную запись службы.
- Добавьте роль администратора Firebase App Distribution .
- Создайте закрытый JSON-ключ и переместите его в место, доступное для вашей среды сборки. Обязательно храните этот файл в безопасном месте , так как он предоставляет администраторский доступ к App Distribution в вашем проекте Firebase.
- Пропустите этот шаг, если вы создали приложение после 20 сентября 2019 года: В консоли Google API включите Firebase App Distribution API. При появлении запроса выберите проект с тем же именем, что и ваш проект 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. Настройте свойства дистрибутива.
In your module (app-level) Gradle file (usually <project>/<app-module>/build.gradle.kts or <project>/<app-module>/build.gradle ), configure App Distribution by adding at least one firebaseAppDistribution section.
Например, чтобы распространить 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 Build Parameters | |
|---|---|
appId | Your app's Firebase App ID. Required only if you don't have the Google Services Gradle plugin installed. You can find the App ID in the appId="1:1234567890:android:321abc456def7890" |
serviceCredentialsFile | Путь к JSON-файлу закрытого ключа вашей учетной записи службы. Требуется только в том случае, если вы используете аутентификацию по учетной записи службы. |
artifactType | Указывает тип файла вашего приложения. Может быть установлено значение |
artifactPath | Укажите абсолютный путь к файлу APK или AAB, который вы хотите загрузить. |
releaseNotes or releaseNotesFile | Примечания к выпуску этой сборки. Вы можете указать либо непосредственно примечания к выпуску, либо путь к текстовому файлу. |
testers or testersFile | Адреса электронной почты тестировщиков, которым вы хотите распространить сборки. Список тестировщиков можно указать в виде списка адресов электронной почты, разделенных запятыми: testers="ali@example.com, bri@example.com, cal@example.com" Или же вы можете указать путь к файлу, содержащему список адресов электронной почты, разделенных запятыми: testersFile="/path/to/testers.txt" |
groups or groupsFile | Группы тестировщиков, которым вы хотите распределить сборки (см. раздел «Управление тестировщиками »). Группы указываются с помощью... Группы можно указать в виде списка псевдонимов групп, разделенных запятыми: groups="qa-team, android-testers" Или же вы можете указать путь к файлу, содержащему список псевдонимов групп, разделенных запятыми: groupsFile="/path/to/tester-groups.txt" |
testDevices or testDevicesFile | Тестовые устройства, на которых вы хотите запустить тесты агента тестирования приложений . Список тестовых устройств можно указать в виде перечня характеристик, разделенных точкой с запятой: testDevices="model=shiba,version=34,locale=en,orientation=portrait" Или же вы можете указать путь к файлу, содержащему список технических характеристик устройства, разделенных точкой с запятой: testDevicesFile="/path/to/testDevices.txt" |
testUsername | Имя пользователя для автоматического входа в систему, используемое во время тестирования агентом App Testing . |
testPassword или testPasswordFile | Пароль для автоматического входа в систему, используемый во время тестирования агентом приложения . Или же вы можете указать путь к текстовому файлу, содержащему пароль: testPasswordFile="/path/to/testPassword.txt" |
testUsernameResource | Имя ресурса для поля имени пользователя, используемого для автоматического входа в систему во время тестирования агентом App Testing. |
testPasswordResource | Имя ресурса для поля пароля, используемого для автоматического входа в систему во время тестирования агентом App Testing. |
testNonBlocking | Если этот флаг установлен при запуске тестов агента App Testing , команда запустит тесты и немедленно вернет управление, не дожидаясь их завершения. Чтобы просмотреть результаты тестов, перейдите в консоль Firebase. Если этот флаг не установлен, команда будет блокироваться до завершения тестов и завершится с кодом ошибки, если какой-либо из тестов завершится неудачей. |
stacktrace | Выводит трассировку стека для пользовательских исключений. Это полезно при отладке проблем. |
Step 4. Distribute your app to testers
Наконец, чтобы упаковать тестовое приложение и пригласить тестировщиков, соберите целевые объекты.
BUILD-VARIANTandappDistributionUpload BUILD-VARIANTwith your project's Gradle wrapper, where BUILD-VARIANT is the optional product flavor and build type you configured in the previous step. For more information about product flavors, see Configure build variants .Например, чтобы распространить ваше приложение, используя вариант сборки
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>. Например:To upload a debug build to 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"Once a tester has been added to your Firebase project, you can add them to individual releases. Testers who are removed will no longer have access to releases in your project, but may still retain access to your releases for a window of time.
Также можно указать тестировщиков, используя
--file="/path/to/testers.txt"вместо--emails".Задачи
appDistributionAddTestersиappDistributionRemoveTestersтакже принимают следующие аргументы:projectNumber: Your Firebase project number.serviceCredentialsFile: The path to your Google service credentials file. This is the same argument used by the upload action.
После загрузки релиза плагин Gradle выводит следующие ссылки. Эти ссылки помогают управлять бинарными файлами и гарантируют, что тестировщики и другие разработчики получат правильный релиз:
-
firebase_console_uri- A link to the Firebase console displaying a single release. You can share this link with other developers in your org. -
testing_uri- A link to the release in the tester experience (Android native app) that lets testers view release notes and install the app onto their device. The tester needs access to the release in order to use the link. -
binary_download_uri- A signed link that directly downloads and installs the app binary (APK or AAB file). The link expires after one hour.
После распространения вашей сборки она становится доступной на панели App Distribution в консоли Firebase в течение 150 дней (пяти месяцев). Когда до истечения срока действия сборки останется 30 дней, уведомление об истечении срока действия появится как в консоли, так и в списке сборок вашего тестировщика на его тестовом устройстве.
Тестировщики, не получившие приглашение к тестированию приложения, получают приглашения по электронной почте для начала работы, а существующие тестировщики получают уведомления по электронной почте о готовности новой сборки к тестированию (инструкции по установке тестового приложения см. в руководстве по настройке тестировщика ). Вы можете отслеживать статус каждого тестировщика — принял ли он приглашение и скачал ли приложение — в консоли Firebase .
У тестировщиков есть 30 дней, чтобы принять приглашение на тестирование приложения, после чего оно истекает. За 5 дней до истечения срока действия приглашения в консоли Firebase рядом с именем тестировщика в релизе появляется уведомление об истечении срока действия. Приглашение можно продлить, отправив его повторно с помощью выпадающего меню в строке с именем тестировщика.
Следующие шаги
Внедрите функцию обратной связи внутри приложения , чтобы тестировщикам было легко отправлять отзывы о вашем приложении (включая скриншоты).
Узнайте, как отображать внутри приложения уведомления для тестировщиков о появлении новых сборок вашего приложения, доступных для установки.
Visit the Android App Bundle codelab to learn how to distribute app bundle releases step by step.
Изучите лучшие практики распространения Android-приложений среди тестировщиков с использованием CI/CD .