Вы можете распространять сборки среди тестировщиков с помощью fastlane — платформы с открытым исходным кодом, которая автоматизирует сборку и выпуск приложений для iOS и Android. Она следует простым инструкциям, определенным в Fastfile . После настройки fastlane и Fastfile вы можете интегрировать App Distribution с вашей конфигурацией fastlane.
Шаг 1. Настройте Fastlane.
Чтобы добавить App Distribution в конфигурацию fastlane, выполните следующую команду из корневой папки вашего iOS-проекта:
fastlane add_plugin firebase_app_distribution
Если команда запросит у вас вариант, выберите
Option 3: RubyGems.org.
Шаг 2. Аутентификация с помощью Firebase.
Прежде чем использовать плагин fastlane, необходимо пройти аутентификацию в вашем проекте Firebase одним из следующих способов. По умолчанию плагин fastlane запрашивает учетные данные через CLI Firebase , если не используется другой метод аутентификации.
Аутентификация с помощью сервисной учетной записи позволяет гибко использовать плагин с вашей системой непрерывной интеграции (CI). Существует два способа предоставления учетных данных сервисной учетной записи:
- Передайте файл ключа вашей учетной записи службы в действие
firebase_app_distribution. Этот метод может оказаться удобным, если файл ключа вашей учетной записи службы уже находится в вашей среде сборки. - Установите переменную среды
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.
Укажите или найдите учетные данные вашей сервисной учетной записи:
- Чтобы передать ключ вашей учетной записи службы в действие
firebase_app_distributionвашего приложения, укажите в параметреservice_credentials_fileпуть к JSON-файлу вашего закрытого ключа. Чтобы найти свои учетные данные в ADC, установите переменную среды
GOOGLE_APPLICATION_CREDENTIALSуказав путь к JSON-файлу закрытого ключа. Например:export GOOGLE_APPLICATION_CREDENTIALS=/absolute/path/to/credentials/file.json
Для получения дополнительной информации об аутентификации с помощью ADC, ознакомьтесь с разделом «Предоставление учетных данных вашему приложению».
- Чтобы передать ключ вашей учетной записи службы в действие
Инструкции по аутентификации вашего проекта см. в разделе «Вход с помощью Firebase CLI» .
Шаг 3. Настройте Fastfile и распространите свое приложение.
- В папку
./fastlane/Fastfileдобавьте блокfirebase_app_distribution. Используйте следующие параметры для настройки дистрибутива:параметры firebase_app_distribution appТребуется только в том случае, если ваше приложение не содержит конфигурационный файл Firebase (
GoogleService-Info.plist) : идентификатор приложения Firebase. Вы можете найти идентификатор приложения в консоли Firebase на странице «Общие настройки» .app: "1:1234567890:ios:0a1b2c3d4e5f67890"
googleservice_info_plist_pathПуть к файлу
GoogleService-Info.plistотносительно пути к архивированному продукту. По умолчанию установлено значениеGoogleService-Info.plist.Этот файл используется для получения идентификатора приложения Firebase, если параметр
appне указан.firebase_cli_tokenТокен обновления, который выводится при аутентификации вашей среды CI с помощью Firebase CLI (подробнее см. в разделе «Использование CLI с системами CI» ).
service_credentials_fileПуть к JSON-файлу вашей учетной записи службы Google. Инструкции по аутентификации с использованием учетных данных учетной записи службы см. выше.
ipa_pathЗаменяет
apk_path(устаревший параметр). Абсолютный путь к IPA-файлу, который вы хотите загрузить. Если не указан, fastlane определяет местоположение файла по тому пути, на котором он был сгенерирован.release_notes
release_notes_fileПримечания к выпуску этой сборки.
Вы можете указать примечания к выпуску напрямую:
release_notes: "Text of release notes"
Или укажите путь к текстовому файлу:
release_notes_file: "/path/to/release-notes.txt"
testers
testers_fileАдреса электронной почты тестировщиков, которых вы хотите пригласить.
Список тестировщиков можно указать в виде списка адресов электронной почты, разделенных запятыми:
testers: "ali@example.com, bri@example.com, cal@example.com"
Или же вы можете указать путь к текстовому файлу, содержащему список адресов электронной почты, разделенных запятыми:
testers_file: "/path/to/testers.txt"
groups
groups_fileГруппы тестировщиков, которые вы хотите пригласить (см. раздел «Управление тестировщиками »). Группы указываются с помощью...
псевдонимы групп , которую вы можете найти в консоли Firebase .Группы можно указать в виде списка, разделенного запятыми:
groups: "qa-team, trusted-testers"
Или же вы можете указать путь к текстовому файлу, содержащему список имен групп, разделенных запятыми:
groups_file: "/path/to/groups.txt"
test_devices
test_devices_fileСледующие типы дистрибутивов входят в состав бета-версии функции автоматического тестирования .
Тестовые устройства, на которые вы хотите распространять сборки (см. раздел «Автоматизированные тесты »).
Список тестовых устройств можно указать в виде списка, разделенного точкой с запятой:
test_devices: "model=shiba,version=34,locale=en,orientation=portrait;model=b0q,version=33,locale=en,orientation=portrait"
Или же вы можете указать путь к текстовому файлу, содержащему список тестовых устройств, разделенных точкой с запятой:
test_devices_file: "/path/to/test-devices.txt"
test_usernameИмя пользователя для автоматического входа в систему, используемое во время автоматизированных тестов .
test_password
test_password_fileПароль для автоматического входа в систему, используемый во время автоматизированных тестов .
Или же вы можете указать путь к текстовому файлу, содержащему пароль:
test_password_file: "/path/to/test-password.txt"
test_username_resourceИмя ресурса для поля имени пользователя, используемого для автоматического входа в систему во время автоматизированных тестов .
test_password_resourceИмя ресурса для поля пароля, используемого для автоматического входа в систему во время автоматизированных тестов .
test_non_blockingЗапускайте автоматизированные тесты асинхронно. Результаты автоматических тестов можно посмотреть в консоли Firebase.
debugЛогический флаг. Вы можете установить его значение в
true, чтобы выводить подробную отладочную информацию.
Например:
platform :ios do desc "My awesome app" lane :distribute do build_ios_app(...) # build_ios_app is a built-in fastlane action. release = firebase_app_distribution( app: "1:123456789:ios:abcd1234", testers: "tester1@company.com, tester2@company.com", release_notes: "Lots of amazing new features to test out!" ) end end
Чтобы сделать сборку доступной для тестировщиков, запустите свою линию:
fastlane <lane>
Возвращаемое значение действия — это хеш, представляющий загруженный релиз. Этот хеш также доступен с помощью lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE] . Для получения дополнительной информации о доступных полях в этом хеше см. документацию по REST API .
После загрузки релиза плагин fastlane выводит следующие ссылки. Эти ссылки помогают управлять бинарными файлами и гарантируют, что тестировщики и другие разработчики получат правильный релиз:
- Ссылка на консоль Firebase , отображающую отдельный релиз. Вы можете поделиться этой ссылкой с другими разработчиками в вашей организации.
- Ссылка на релиз в интерфейсе тестировщика (веб-клип для iOS), позволяющая тестировщикам просмотреть примечания к релизу и установить приложение на свое устройство. Для использования ссылки тестировщику необходим доступ к релизу.
- Подписанная ссылка, которая напрямую загружает и устанавливает исполняемый файл приложения (IPA-файл). Ссылка действительна в течение одного часа.
После распространения вашей сборки она будет доступна на панели App Distribution в консоли Firebase в течение 150 дней. Когда до истечения срока действия сборки останется 30 дней, в консоли и в списке сборок тестировщика на его тестовом устройстве появится уведомление об истечении срока действия.
Тестировщики, которые ранее не были приглашены к тестированию приложения, получают приглашения по электронной почте для начала работы. Существующие тестировщики получают уведомления по электронной почте о готовности новой сборки к тестированию. Чтобы узнать, как установить тестовое приложение, см. раздел «Настройка в качестве тестировщика» . Вы можете отслеживать статус каждого тестировщика, чтобы определить, принял ли он приглашение и загрузил ли приложение в консоли Firebase .
(Необязательно) Чтобы автоматически увеличивать номер сборки при каждом создании нового релиза в App Distribution, вы можете использовать действия firebase_app_distribution_get_latest_release и increment_build_number . Следующий код демонстрирует пример автоматического увеличения номера сборки:
lane :increment_version do
latest_release = firebase_app_distribution_get_latest_release(
app: "<your Firebase app ID>"
)
increment_build_number({ build_number: latest_release[:buildVersion].to_i + 1 })
end
Чтобы узнать больше об этой функции плагина fastlane, см. раздел «Получение информации о последней версии вашего приложения» .
Шаг 4 (необязательный). Управление тестировщиками для дистрибутива.
Вы можете добавлять и удалять тестировщиков из своего проекта или группы, используя файл Fastfile или напрямую запуская действия fastlane. Запуск действий напрямую переопределяет значения, установленные в вашем Fastfile .
После добавления тестировщика в ваш проект Firebase вы можете добавлять его в отдельные релизы. Тестировщики, удаленные из вашего проекта Firebase, больше не имеют доступа к релизам в вашем проекте, но они могут сохранить доступ к вашим релизам на определенный период времени.
Если у вас большое количество тестировщиков, вам следует рассмотреть возможность использования групп.
Используйте Fastfile
# Use lanes to add or remove testers from a project. lane(:add_testers) do firebase_app_distribution_add_testers( emails: "foo@google.com,bar@google.com" # or file: "/path/to/testers.txt" group_alias: "qa-team" # (Optional) add testers to this group ) end lane(:remove_testers) do firebase_app_distribution_remove_testers( emails: "foo@google.com,bar@google.com" # or file: "/path/to/testers.txt" group_alias: "qa-team" # (Optional) remove testers from this group only ) end
# Add or remove testers with the terminal
$ fastlane add_testers
$ fastlane remove_testersВыполните действия на скоростной полосе
fastlane run firebase_app_distribution_create_group display_name:"QA Team" alias:"qa-team"fastlane run firebase_app_distribution_add_testers group_alias:"qa-team" emails:"foo@google.com,bar@google.com"fastlane run firebase_app_distribution_remove_testers group_alias:"qa-team" emails:"foo@google.com,bar@google.com"fastlane run firebase_app_distribution_delete_group alias:"qa-team"
Также можно указать тестировщиков, используя --file="/path/to/testers.txt вместо --emails .
Задачи firebase_app_distribution_add_testers и firebase_app_distribution_remove_testers также принимают следующие аргументы:
-
project_name: Номер вашего проекта Firebase. -
group_alias(необязательно): Если указано, тестировщики добавляются в указанную группу (или удаляются из нее). -
service_credentials_file: Путь к файлу учетных данных вашей службы Google. -
firebase_cli_token: Токен аутентификации для Firebase CLI.
Параметры service_credentials_file и firebase_cli_token — это те же аргументы, которые используются в действии загрузки.
Шаг 5 (необязательно). Получите информацию о последней версии вашего приложения.
С помощью действия firebase_app_distribution_get_latest_release вы можете получить информацию о последней версии вашего приложения в App Distribution, включая информацию о версии приложения, примечания к выпуску и время создания. Примеры использования включают автоматическое повышение версии и перенос примечаний к выпуску из предыдущей версии.
Возвращаемое значение действия — это хеш, представляющий последнюю версию. Этот хеш также доступен с помощью lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE] . Для получения дополнительной информации о доступных полях в этом хеше см. документацию по REST API .
Параметры
| параметры firebase_app_distribution_get_latest_release | |
|---|---|
app | Требуется только в том случае, если ваше приложение не содержит конфигурационный файл Firebase ( app: "1:1234567890:ios:0a1b2c3d4e5f67890" |
googleservice_info_plist_path | Путь к файлу Этот файл используется для получения идентификатора приложения Firebase, если параметр |
firebase_cli_token | Токен обновления, который выводится при аутентификации вашей среды CI с помощью Firebase CLI (подробнее см. в разделе «Использование CLI с системами CI» ). |
service_credentials_file | Путь к JSON-файлу вашей учетной записи службы Google. Инструкции по аутентификации с использованием учетных данных учетной записи службы см. в предыдущей документации. |
service_credentials_json_data | Содержимое JSON-файла учетной записи службы Google. Инструкции по аутентификации с использованием учетных данных учетной записи службы см. в предыдущей документации. |
debug | Логический флаг. Вы можете установить его значение в |
Следующие шаги
Для регистрации дополнительных устройств вручную или программно см. раздел «Регистрация дополнительных устройств iOS» .
Изучите лучшие практики распространения приложений Apple среди тестировщиков с использованием CI/CD и fastlane .