Distribuire app per Android ai tester utilizzando fastlane

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 per iOS e Android. Questo documento segue le istruzioni definite in un Fastfile. Dopo aver configurato fastlane e il tuo Fastfile, puoi integrare App Distribution con la configurazione di fastlane.

Prima di iniziare

Se non l'hai ancora 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 in futuro decidi di utilizzare altri prodotti, assicurati di completare tutti i passaggi della pagina collegata sopra.

Passaggio 1: Configurare fastlane

1. Installa e configura fastlane.

2. Per aggiungere App Distribution alla configurazione di fastlane, esegui questo comando dalla radice del progetto Android:

   fastlane add_plugin firebase_app_distribution

   Se il comando ti chiede di scegliere un'opzione, seleziona Option 3: RubyGems.org.

Passaggio 2: Autenticarsi con Firebase

Prima di poter utilizzare il plug-in fastlane, devi 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 un altro metodo di autenticazione.

Passaggio 3: Configurare Fastfile e distribuire l'app

1. In una corsia ./fastlane/Fastfile, aggiungi un blocco firebase_app_distribution. Utilizza 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 stampato quando autentichi l'ambiente CI con l'interfaccia a riga di comando Firebase (per saperne di più, leggi Utilizzare l'interfaccia a riga di comando con i sistemi CI).
   service_credentials_file	Il percorso del file JSON dell'account di servizio Google. Vedi sopra come autenticarsi utilizzando le credenziali del service account.
   android_artifact_type	Specifica il tipo di file Android (APK o AAB).
   android_artifact_path	Sostituisce apk_path (ritirato). Percorso assoluto del file APK o AAB da caricare. Se non specificato, fastlane determina la posizione del file dalla corsia in cui è stato generato.
   release_notes release_notes_file	Note di rilascio per questa build. Puoi specificare direttamente le note di rilascio: release_notes: "Text of release notes" In alternativa, specifica il percorso di un file di testo normale: release_notes_file: "/path/to/release-notes.txt"
   testers testers_file	Gli indirizzi email dei tester che vuoi 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 normale contenente un elenco di indirizzi email separati da virgole: testers_file: "/path/to/testers.txt"
   groups groups_file	I gruppi di tester che vuoi invitare (consulta la sezione Gestire i tester). I gruppi vengono specificati utilizzando gli alias di gruppo, che puoi cercare nella console Firebase. Puoi specificare i gruppi come elenco separato da virgole: groups: "qa-team, trusted-testers" In alternativa, puoi specificare il percorso di un file di testo normale 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 di Automated tester. I dispositivi di test su cui vuoi distribuire le build (fai riferimento a Test automatizzati). Puoi 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, puoi specificare il percorso di un file di testo normale 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. In alternativa, puoi specificare il percorso di un file di testo normale contenente una password: test_password_file: "/path/to/test-password.txt"
   test_username_resource	Nome della risorsa per il campo del nome utente per l'accesso automatico da utilizzare durante i test automatizzati.
   test_password_resource	Nome della risorsa per il campo della password per l'accesso automatico da utilizzare durante i test automatizzati.
   test_non_blocking	Esegui test automatici in modo asincrono. Visita la Console Firebase per visualizzare i risultati dei test automatici.
   debug	Un flag booleano. Puoi impostare questo valore su true per stampare l'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 disponibile la build ai tester, esegui la corsia:

fastlane <lane>

Il valore restituito dell'azione è un hash che rappresenta la release caricata. Questo hash è disponibile anche utilizzando lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE]. Per saperne di più sui campi disponibili in questo hash, consulta la documentazione dell'API REST.

Il plug-in fastlane restituisce i seguenti link dopo il caricamento della release. Questi link ti aiutano a gestire i file binari e a garantire che i tester e gli altri sviluppatori dispongano della release corretta:

• Un link alla console Firebase che mostra una singola release. Puoi condividere questo link con altri sviluppatori della tua organizzazione.
• Un link alla release nell'esperienza del tester (app nativa per Android) che consente ai tester di visualizzare le note di rilascio e installare l'app sul proprio dispositivo. Per utilizzare il link, il tester deve avere accesso alla release.
• Un link firmato che scarica e installa direttamente il binario dell'app (file APK o AAB). Il link scade dopo un'ora.

Dopo aver distribuito la build, questa è disponibile nella dashboard App Distribution della console Firebase per 150 giorni. Quando la build scade tra 30 giorni, nella console e nell'elenco delle build del tester sul dispositivo di test viene visualizzato un avviso di scadenza.

I tester che non sono stati invitati in precedenza a testare l'app ricevono inviti via email per iniziare. I tester esistenti ricevono notifiche email che li informano che una nuova build è pronta per essere testata. Per scoprire come installare l'app di test, consulta la guida alla configurazione dei tester. Puoi monitorare lo stato di ogni 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 release in App Distribution, puoi utilizzare l'azione firebase_app_distribution_get_latest_release e, ad esempio, il plug-in fastlane increment_version_code. Il seguente codice 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 scoprire di più sull'azione firebase_app_distribution_get_latest_release, consulta la pagina Visualizzare informazioni sull'ultima release dell'app.

(Facoltativo) Passaggio 4. 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 di fastlane. L'esecuzione diretta delle azioni override dei valori impostati in Fastfile.

Una volta aggiunto un tester al tuo progetto Firebase, puoi aggiungerlo a singole release. I tester rimossi dal tuo progetto Firebase non hanno più accesso alle release del progetto, ma potrebbero mantenere l'accesso alle tue release per un periodo di tempo.

Se hai un numero elevato di tester, ti consigliamo di utilizzare i gruppi.

Utilizza 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 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"

Puoi anche specificare i tester utilizzando --file="/path/to/testers.txt anziché --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.

(Facoltativo) Passaggio 5. Visualizzare informazioni sull'ultima release dell'app

Puoi utilizzare l'azione firebase_app_distribution_get_latest_release per recuperare informazioni sull'ultima release della tua app in App Distribution, tra cui informazioni sulla versione dell'app, note di rilascio e ora di creazione. I casi d'uso includono l'aumento automatico della versione e il riporto delle note di rilascio della release precedente.

Il valore restituito dell'azione è un hash che rappresenta l'ultima release. Questo hash è disponibile anche utilizzando lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE]. Per saperne di più sui campi disponibili in questo hash, consulta la documentazione dell'API REST.

Parametri

app: "1:1234567890:android:0a1b2c3d4e5f67890"

Passaggi successivi

• Implementa il feedback in-app per consentire ai tester di inviare facilmente feedback sulla tua app (inclusi screenshot).

• Scopri come mostrare avvisi in-app ai tuoi tester quando sono disponibili nuove build della tua app da installare.

• Scopri le best practice per distribuire app per Android ai tester QA utilizzando CI/CD.