Możesz rozpowszechniać kompilacje wśród testerów za pomocą Fastlane , platformy open source, która automatyzuje tworzenie i wydawanie aplikacji na iOS i Androida. Postępuje zgodnie z prostymi instrukcjami zdefiniowanymi w pliku Fastfile
. Po skonfigurowaniu Fastlane i Fastfile
możesz zintegrować Dystrybucję aplikacji z konfiguracją Fastlane.
Krok 1. Skonfiguruj fastlane
Aby dodać dystrybucję aplikacji do konfiguracji Fastlane, uruchom następujące polecenie w katalogu głównym projektu na iOS:
fastlane add_plugin firebase_app_distribution
Jeśli polecenie wyświetli monit z opcją, wybierz
Option 3: RubyGems.org
.
Krok 2. Uwierzytelnij się w Firebase
Zanim będziesz mógł korzystać z wtyczki Fastlane, musisz najpierw uwierzytelnić się w projekcie Firebase na jeden z poniższych sposobów. Domyślnie wtyczka Fastlane szuka poświadczeń w interfejsie CLI Firebase, jeśli nie jest używana żadna inna metoda uwierzytelniania.
Uwierzytelnienie za pomocą konta usługi pozwala na elastyczne korzystanie z wtyczki z systemem ciągłej integracji (CI). Dane uwierzytelniające konto usługi można podać na dwa sposoby:
- Przekaż plik klucza konta usługi do akcji
firebase_app_distribution
. Ta metoda może okazać się wygodna, jeśli masz już plik klucza konta usługi w środowisku kompilacji. - Ustaw zmienną środowiskową
GOOGLE_APPLICATION_CREDENTIALS
tak, aby wskazywała plik kluczy konta usługi. Możesz preferować tę metodę, jeśli masz już skonfigurowane domyślne poświadczenia aplikacji (ADC) dla innej usługi Google (np. Google Cloud).
- W Google Cloud Console wybierz swój projekt i utwórz nowe konto usługi.
- Dodaj rolę administratora dystrybucji aplikacji Firebase .
- Utwórz prywatny klucz JSON i przenieś klucz do lokalizacji dostępnej dla Twojego środowiska kompilacji. Pamiętaj, aby przechowywać ten plik w bezpiecznym miejscu , ponieważ zapewnia on administratorowi dostęp do dystrybucji aplikacji w Twoim projekcie Firebase.
- Pomiń ten krok, jeśli aplikację utworzyłeś po 20 września 2019 r.: W konsoli Google API włącz interfejs Firebase App Distribution API. Po wyświetleniu monitu wybierz projekt o tej samej nazwie, co projekt Firebase.
Podaj lub znajdź dane logowania do swojego konta usługi:
- Aby przekazać klucz konta usługi do akcji
firebase_app_distribution
na swoim pasie, ustaw parametrservice_credentials_file
ścieżką do pliku JSON klucza prywatnego Aby zlokalizować swoje dane uwierzytelniające w ADC, ustaw zmienną środowiskową
GOOGLE_APPLICATION_CREDENTIALS
na ścieżkę do pliku JSON klucza prywatnego. Na przykład:export GOOGLE_APPLICATION_CREDENTIALS=/absolute/path/to/credentials/file.json
Aby uzyskać więcej informacji na temat uwierzytelniania za pomocą usługi ADC, zobacz Podawanie poświadczeń do aplikacji.
- Aby przekazać klucz konta usługi do akcji
Aby uzyskać instrukcje dotyczące uwierzytelniania projektu, zobacz Logowanie przy użyciu interfejsu wiersza polecenia Firebase .
Krok 3. Skonfiguruj Fastfile i rozpowszechniaj swoją aplikację
- Na ścieżce
./fastlane/Fastfile
dodaj blokfirebase_app_distribution
. Aby skonfigurować dystrybucję, użyj następujących parametrów:parametry firebase_app_distribution app
Wymagane tylko wtedy, gdy Twoja aplikacja nie zawiera pliku konfiguracyjnego Firebase (
GoogleService-Info.plist
) : identyfikator aplikacji Firebase Twojej aplikacji. Identyfikator aplikacji znajdziesz w konsoli Firebase, na stronie Ustawienia ogólne .app: "1:1234567890:ios:0a1b2c3d4e5f67890"
googleservice_info_plist_path
Ścieżka do pliku
GoogleService-Info.plist
względem ścieżki zarchiwizowanego produktu. Domyślnie ustawGoogleService-Info.plist
.Plik służy do pobrania identyfikatora aplikacji Firebase Twojej aplikacji, jeśli parametr
app
nie jest określony.firebase_cli_token
Token odświeżania drukowany podczas uwierzytelniania środowiska CI za pomocą interfejsu CLI Firebase (więcej informacji można znaleźć w artykule Używanie interfejsu CLI w systemach CI ).
service_credentials_file
Ścieżka do pliku JSON konta usługi Google. Zobacz powyżej, jak uwierzytelnić się przy użyciu poświadczeń konta usługi .
ipa_path
Zastępuje
apk_path
(przestarzałą). Ścieżka bezwzględna do pliku IPA, który chcesz przesłać. Jeśli nie określono, Fastlane określa lokalizację pliku na podstawie ścieżki, na której plik został wygenerowany.release_notes
release_notes_file
Informacje o wersji dla tej kompilacji.
Możesz bezpośrednio określić informacje o wersji:
release_notes: "Text of release notes"
Lub określ ścieżkę do zwykłego pliku tekstowego:
release_notes_file: "/path/to/release-notes.txt"
testers
testers_file
Adresy e-mail testerów, których chcesz zaprosić.
Możesz określić testerów jako listę adresów e-mail rozdzielonych przecinkami:
testers: "ali@example.com, bri@example.com, cal@example.com"
Możesz też określić ścieżkę do zwykłego pliku tekstowego zawierającego listę adresów e-mail rozdzielonych przecinkami:
testers_file: "/path/to/testers.txt"
groups
groups_file
Grupy testerów, które chcesz zaprosić (więcej informacji znajdziesz w Zarządzaj testerami ). Grupy są określane przy użyciu
aliasy grupowe , które możesz sprawdzić w konsoli Firebase.Grupy można określić w formie listy rozdzielanej przecinkami:
groups: "qa-team, trusted-testers"
Możesz też określić ścieżkę do zwykłego pliku tekstowego zawierającego listę nazw grup rozdzielonych przecinkami:
groups_file: "/path/to/groups.txt"
debug
Flaga logiczna. Możesz ustawić tę opcję na
true
, aby wydrukować szczegółowe dane wyjściowe debugowania.
Na przykład:
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
Aby udostępnić kompilację testerom, uruchom swój tor:
fastlane <lane>
Wartością zwracaną przez akcję jest hash reprezentujący przesłaną wersję. Ten skrót jest również dostępny przy użyciu lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE]
. Więcej informacji na temat dostępnych pól w tym hashu znajdziesz w dokumentacji API REST .
Wtyczka Fastlane wyświetla następujące łącza po przesłaniu wersji. Te linki pomogą Ci zarządzać plikami binarnymi i zapewnić testerom i innym programistom właściwą wersję:
- Link do konsoli Firebase wyświetlający pojedynczą wersję. Możesz udostępnić ten link innym programistom w swojej organizacji.
- Link do wersji w środowisku testera (klip internetowy iOS), który umożliwia testerom przeglądanie informacji o wersji i instalowanie aplikacji na swoim urządzeniu. Tester musi mieć dostęp do wydania, aby móc skorzystać z linku.
- Podpisany link, który bezpośrednio pobiera i instaluje plik binarny aplikacji (plik IPA). Link wygasa po godzinie.
Po rozpowszechnieniu kompilacji będzie ona dostępna w panelu dystrybucji aplikacji w konsoli Firebase przez 150 dni. Gdy do wygaśnięcia kompilacji pozostało 30 dni, w konsoli oraz na liście kompilacji testera na urządzeniu testowym pojawi się powiadomienie o wygaśnięciu.
Testerzy, którzy nie zostali wcześniej zaproszeni do testowania aplikacji, otrzymują zaproszenia e-mailem, aby rozpocząć. Obecni testerzy otrzymują powiadomienia e-mailem, że nowa kompilacja jest gotowa do testowania. Aby dowiedzieć się, jak zainstalować aplikację testową, zobacz temat Konfiguracja jako tester . Możesz monitorować status każdego testera, aby sprawdzić, czy przyjął zaproszenie i czy pobrał aplikację w konsoli Firebase.
(Opcjonalnie) Aby automatycznie zwiększać numer kompilacji za każdym razem, gdy tworzysz nową wersję w App Distribution, możesz użyć akcji firebase_app_distribution_get_latest_release
i akcji increment_build_number
. Poniższy kod zawiera przykład automatycznego zwiększania numeru kompilacji:
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
Aby dowiedzieć się więcej na temat tej funkcji wtyczki Fastlane, zobacz Uzyskiwanie informacji o najnowszej wersji aplikacji .
Krok 4 (opcjonalnie). Zarządzaj testerami dystrybucji
Możesz dodawać i usuwać testerów ze swojego projektu lub grupy, korzystając z pliku Fastfile
lub bezpośrednio uruchamiając akcje Fastlane. Uruchamianie akcji bezpośrednio zastępuje wartości ustawione w Fastfile
.
Po dodaniu testera do projektu Firebase możesz dodać go do poszczególnych wersji. Testerzy usunięci z projektu Firebase nie mają już dostępu do wersji w Twoim projekcie, ale mogą zachować dostęp do Twoich wersji przez pewien czas.
Jeśli masz dużą liczbę testerów, powinieneś rozważyć użycie grup.
Użyj 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
Uruchom działania Fastlane
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"
Możesz także określić testerów, używając --file="/path/to/testers.txt
zamiast --emails
.
Zadania firebase_app_distribution_add_testers
i firebase_app_distribution_remove_testers
akceptują również następujące argumenty:
-
project_name
: numer Twojego projektu Firebase. -
group_alias
(opcjonalne): Jeśli określono, testerzy są dodawani (lub usuwani z) określonej grupy. -
service_credentials_file
: Ścieżka do pliku danych uwierzytelniających usługi Google. -
firebase_cli_token
: Token uwierzytelniania dla interfejsu wiersza polecenia Firebase.
service_credentials_file
i firebase_cli_token
to te same argumenty, których używa akcja przesyłania.
Krok 5 (opcjonalnie). Uzyskaj informacje o najnowszej wersji swojej aplikacji
Możesz użyć akcji firebase_app_distribution_get_latest_release
, aby pobrać informacje o najnowszej wersji aplikacji w App Distribution, w tym informacje o wersji aplikacji, informacje o wersji i czas utworzenia. Przykłady użycia obejmują automatyczne zwiększanie wersji i przenoszenie informacji o wersji z poprzedniej wersji.
Wartość zwracana przez akcję to skrót reprezentujący najnowszą wersję. Ten skrót jest również dostępny przy użyciu lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE]
. Więcej informacji na temat dostępnych pól w tym hashu znajdziesz w dokumentacji API REST .
Parametry
parametry firebase_app_distribution_get_latest_release | |
---|---|
app | Wymagane tylko wtedy, gdy Twoja aplikacja nie zawiera pliku konfiguracyjnego Firebase ( app: "1:1234567890:ios:0a1b2c3d4e5f67890" |
googleservice_info_plist_path | Ścieżka do pliku Plik służy do pobrania identyfikatora aplikacji Firebase Twojej aplikacji, jeśli parametr |
firebase_cli_token | Token odświeżania drukowany podczas uwierzytelniania środowiska CI za pomocą interfejsu CLI Firebase (więcej informacji można znaleźć w artykule Używanie interfejsu CLI w systemach CI ). |
service_credentials_file | Ścieżka do pliku JSON konta usługi Google. Zobacz powyżej, jak uwierzytelnić się przy użyciu poświadczeń konta usługi . |
debug | Flaga logiczna. Możesz ustawić tę opcję na |
Następne kroki
Aby zarejestrować więcej urządzeń ręcznie lub programowo, zobacz Rejestrowanie dodatkowych urządzeń z systemem iOS .
Poznaj najlepsze praktyki dystrybucji aplikacji Apple wśród testerów kontroli jakości przy użyciu CI/CD i Fastlane .