Questo documento descrive come distribuire le build APK ai tester utilizzando fastlane , una piattaforma open source che automatizza la creazione e il rilascio di app iOS e Android. Questo documento segue le istruzioni definite in un Fastfile
. Dopo aver configurato fastlane e Fastfile
, puoi integrare App Distribution con la configurazione fastlane.
Prima di iniziare
Se non l'hai già fatto, aggiungi Firebase al tuo progetto Android .
Se non utilizzi altri prodotti Firebase, devi solo creare un progetto e registrare la tua app. Tuttavia, se decidi di utilizzare prodotti aggiuntivi in futuro, assicurati di completare tutti i passaggi nella pagina collegata sopra.
Passaggio 1. Configura la corsia veloce
Per aggiungere App Distribution alla configurazione Fastlane, esegui il seguente comando dalla root del tuo progetto Android:
fastlane add_plugin firebase_app_distribution
Se il comando ti richiede un'opzione, seleziona
Option 3: RubyGems.org
.
Passaggio 2. Autenticarsi con Firebase
Prima di poter utilizzare il plug-in Fastlane, devi prima autenticarti con il tuo progetto Firebase in uno dei seguenti modi. Per impostazione predefinita, il plug-in Fastlane cerca le credenziali dalla CLI Firebase se non viene utilizzato nessun altro metodo di autenticazione.
L'autenticazione con un account di servizio ti consente di utilizzare in modo flessibile il plug-in con il tuo sistema di integrazione continua (CI). Esistono due modi per fornire le credenziali dell'account di servizio:
- Passa il file della chiave dell'account di servizio all'azione
firebase_app_distribution
. Potresti trovare utile questo metodo se hai già il file della chiave dell'account di servizio nel tuo ambiente di compilazione. - Imposta la variabile di ambiente
GOOGLE_APPLICATION_CREDENTIALS
in modo che punti al file della chiave dell'account di servizio. Potresti preferire questo metodo se hai già configurato le credenziali predefinite dell'applicazione (ADC) per un altro servizio Google (ad esempio Google Cloud).
- Nella console Google Cloud, seleziona il tuo progetto e crea un nuovo account di servizio.
- Aggiungi il ruolo di amministratore della distribuzione dell'app Firebase .
- Crea una chiave JSON privata e sposta la chiave in una posizione accessibile al tuo ambiente di compilazione. Assicurati di conservare questo file in un posto sicuro , poiché concede l'accesso amministrativo alla distribuzione delle app nel tuo progetto Firebase.
- Salta questo passaggio se hai creato la tua app dopo il 20 settembre 2019: nella console delle API di Google, abilita l' API Firebase App Distribution. Quando richiesto, seleziona il progetto con lo stesso nome del tuo progetto Firebase.
Fornisci o individua le credenziali del tuo account di servizio:
- Per passare la chiave dell'account di servizio all'azione
firebase_app_distribution
della tua corsia, imposta il parametroservice_credentials_file
con il percorso del file JSON della chiave privata Per individuare le tue credenziali con ADC, imposta la variabile di ambiente
GOOGLE_APPLICATION_CREDENTIALS
sul percorso del file JSON della chiave privata. Ad esempio:export GOOGLE_APPLICATION_CREDENTIALS=/absolute/path/to/credentials/file.json
Per ulteriori informazioni sull'autenticazione con ADC, leggi Fornire le credenziali all'applicazione.
- Per passare la chiave dell'account di servizio all'azione
Consulta Accedi con la CLI Firebase per istruzioni su come autenticare il tuo progetto.
Passaggio 3. Configura il tuo Fastfile e distribuisci la tua app
- In una corsia
./fastlane/Fastfile
, aggiungi un bloccofirebase_app_distribution
. Utilizzare i seguenti parametri per configurare la distribuzione:parametri firebase_app_distribution app
Obbligatorio : l'ID app Firebase della tua app. Puoi trovare l'ID app nella console Firebase, nella pagina Impostazioni generali .
app: "1:1234567890:android:0a1b2c3d4e5f67890"
firebase_cli_token
Un token di aggiornamento che viene stampato quando autentichi il tuo ambiente CI con la CLI Firebase (leggi Utilizzare la CLI con i sistemi CI per ulteriori informazioni).
service_credentials_file
Il percorso del file json del tuo account di servizio Google. Vedi sopra per informazioni su come eseguire l'autenticazione utilizzando le credenziali dell'account di servizio .
android_artifact_type
Specifica il tipo di file Android (APK o AAB).
android_artifact_path
Sostituisce
apk_path
(obsoleto). Percorso assoluto del file APK o AAB che desideri caricare. Se non specificato, fastlane determina la posizione del file dalla corsia in cui è stato generato il file.release_notes
release_notes_file
Note sulla versione per questa build.
È possibile specificare direttamente le note di rilascio:
release_notes: "Text of release notes"
Oppure specifica il percorso di un file di testo semplice:
release_notes_file: "/path/to/release-notes.txt"
testers
testers_file
Gli indirizzi email dei tester che desideri invitare.
Puoi specificare i tester come un elenco di indirizzi email separati da virgole:
testers: "ali@example.com, bri@example.com, cal@example.com"
In alternativa, puoi specificare il percorso di un file di testo contenente un elenco di indirizzi email separati da virgole:
testers_file: "/path/to/testers.txt"
groups
groups_file
I gruppi di tester che desideri invitare (consulta Gestisci tester ). I gruppi vengono specificati utilizzando
alias di gruppo , che puoi cercare nella console Firebase.È possibile specificare i gruppi come elenco separato da virgole:
groups: "qa-team, trusted-testers"
In alternativa, puoi specificare il percorso di un file di testo semplice contenente un elenco di nomi di gruppi separati da virgole:
groups_file: "/path/to/groups.txt"
test_devices
test_devices_file
I seguenti tipi di distribuzione fanno parte della funzionalità beta del tester automatizzato .
I dispositivi di test a cui desideri distribuire le build (fai riferimento a Test automatizzati ).
È possibile specificare i dispositivi di test come elenco di dispositivi di test separati da punto e virgola:
test_devices: "model=shiba,version=34,locale=en,orientation=portrait;model=b0q,version=33,locale=en,orientation=portrait"
In alternativa, è possibile specificare il percorso di un file di testo contenente un elenco di dispositivi di test separati da punto e virgola:
test_devices_file: "/path/to/test-devices.txt"
test_username
Il nome utente per l'accesso automatico da utilizzare durante i test automatizzati .
test_password
test_password_file
La password per l'accesso automatico da utilizzare durante i test automatizzati .
Oppure puoi specificare il percorso di un file di testo semplice contenente una password:
test_password_file: "/path/to/test-password.txt"
test_username_resource
Nome risorsa per il campo nome utente per l'accesso automatico da utilizzare durante i test automatizzati .
test_password_resource
Nome risorsa per il campo password per l'accesso automatico da utilizzare durante i test automatizzati .
test_non_blocking
Esegui test automatizzati in modo asincrono. Visita la console Firebase per i risultati dei test automatici.
debug
Una bandiera booleana. È possibile impostarlo su
true
per stampare un output di debug dettagliato.
platform :android do desc "My awesome app" lane :distribute do build_android_app(...) # build_android_app is a built-in fastlane action. release = firebase_app_distribution( app: "1:123456789:android:abcd1234", testers: "tester1@company.com, tester2@company.com", release_notes: "Lots of amazing new features to test out!" ) end end
Per rendere la build disponibile ai tester, esegui la tua corsia:
fastlane <lane>
Il valore restituito dell'azione è un hash che rappresenta la versione caricata. Questo hash è disponibile anche utilizzando lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE]
. Per ulteriori informazioni sui campi disponibili in questo hash, consulta la documentazione dell'API REST .
Il plug-in fastlane genera i seguenti collegamenti dopo il caricamento della versione. Questi collegamenti ti aiutano a gestire i file binari e a garantire che i tester e gli altri sviluppatori dispongano della versione corretta:
- Un collegamento alla console Firebase che mostra una singola versione. Puoi condividere questo collegamento con altri sviluppatori nella tua organizzazione.
- Un collegamento alla versione nell'esperienza del tester (app nativa Android) che consente ai tester di visualizzare le note sulla versione e installare l'app sul proprio dispositivo. Il tester deve accedere alla versione per poter utilizzare il collegamento.
- Un collegamento firmato che scarica e installa direttamente il file binario dell'app (file APK o AAB). Il collegamento scade dopo un'ora.
Dopo aver distribuito la build, questa sarà disponibile nella dashboard Distribuzione app della console Firebase per 150 giorni. Quando mancano 30 giorni alla scadenza della build, viene visualizzato un avviso di scadenza nella console e nell'elenco delle build del tester sul dispositivo di test.
I tester che non sono stati precedentemente invitati a testare l'app ricevono inviti via email per iniziare. I tester esistenti ricevono notifiche via email che una nuova build è pronta per essere testata. Per informazioni su come installare l'app di prova, consulta la guida alla configurazione del tester . Puoi monitorare lo stato di ciascun tester per determinare se ha accettato l'invito e se ha scaricato l'app nella console Firebase.
(Facoltativo) Per incrementare automaticamente il numero di build ogni volta che crei una nuova versione in App Distribution, puoi utilizzare l' azione firebase_app_distribution_get_latest_release
e, ad esempio, il plugin fastlane increment_version_code
. Il codice seguente fornisce un esempio di come incrementare automaticamente il numero di build:
lane :increment_version do
latest_release = firebase_app_distribution_get_latest_release(
app: "<your Firebase app ID>"
)
increment_version_code({ version_code: latest_release[:buildVersion].to_i + 1 })
end
Per ulteriori informazioni sull'azione firebase_app_distribution_get_latest_release
, vedi Ottenere informazioni sull'ultima versione della tua app .
Passaggio 4 (facoltativo). Gestione dei tester per la distribuzione
Puoi aggiungere e rimuovere tester dal tuo progetto o gruppo utilizzando il file Fastfile
o eseguendo direttamente le azioni fastlane. L'esecuzione delle azioni sovrascrive direttamente i valori impostati nel Fastfile
.
Una volta aggiunto un tester al tuo progetto Firebase, puoi aggiungerlo alle singole versioni. I tester che vengono rimossi dal tuo progetto Firebase non hanno più accesso alle versioni nel tuo progetto, ma potrebbero mantenere l'accesso alle tue versioni per un periodo di tempo.
Se hai un gran numero di tester dovresti prendere in considerazione l'utilizzo dei gruppi.
Usa 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
Esegui azioni sulla corsia veloce
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"
Puoi anche specificare i tester utilizzando --file="/path/to/testers.txt
invece di --emails
.
Le attività firebase_app_distribution_add_testers
e firebase_app_distribution_remove_testers
accettano anche i seguenti argomenti:
-
project_name
: il numero del tuo progetto Firebase. -
group_alias
(facoltativo): se specificato, i tester vengono aggiunti (o rimossi dal) gruppo specificato. -
service_credentials_file
: il percorso del file delle credenziali del servizio Google. -
firebase_cli_token
: token di autenticazione per la CLI Firebase.
service_credentials_file
e firebase_cli_token
sono gli stessi argomenti utilizzati dall'azione di caricamento.
Passaggio 5 (facoltativo). Ottieni informazioni sull'ultima versione della tua app
Puoi utilizzare l'azione firebase_app_distribution_get_latest_release
per recuperare informazioni sull'ultima versione della tua app in App Distribution, incluse informazioni sulla versione dell'app, note sulla versione e ora di creazione. I casi d'uso includono l'aumento automatico della versione e il trasferimento delle note di rilascio dalla versione precedente.
Il valore restituito dell'azione è un hash che rappresenta l'ultima versione. Questo hash è disponibile anche utilizzando lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE]
. Per ulteriori informazioni sui campi disponibili in questo hash, consulta la documentazione dell'API REST .
Parametri
parametri firebase_app_distribution_get_latest_release | |
---|---|
app | Obbligatorio : l'ID app Firebase della tua app. Puoi trovare l'ID app nella console Firebase, nella pagina Impostazioni generali . app: "1:1234567890:android:0a1b2c3d4e5f67890" |
firebase_cli_token | Un token di aggiornamento che viene stampato quando autentichi il tuo ambiente CI con la CLI Firebase (leggi Utilizzare la CLI con i sistemi CI per ulteriori informazioni). |
service_credentials_file | Il percorso del file json del tuo account di servizio Google. Vedi sopra per informazioni su come eseguire l'autenticazione utilizzando le credenziali dell'account di servizio . |
debug | Una bandiera booleana. È possibile impostarlo su |
Prossimi passi
Implementa il feedback in-app per consentire ai tester di inviare facilmente feedback sulla tua app (compresi gli screenshot).
Scopri come visualizzare avvisi in-app ai tuoi tester quando sono disponibili per l'installazione nuove build della tua app.
Scopri le best practice per la distribuzione di app Android ai tester del QA utilizzando CI/CD .