Android-Apps per Schnellzugriff an Tester verteilen


In diesem Dokument wird beschrieben, wie Sie APK-Builds mit fastlane an Tester verteilen. fastlane ist eine Open-Source-Plattform, mit der das Erstellen und Veröffentlichen von iOS- und Android-Apps automatisiert wird. Dieses Dokument entspricht der Anleitung, die in einem Fastfile definiert ist. Nachdem du Fastlane und deine Fastfile eingerichtet hast, kannst du App Distribution in deine Fastlane-Konfiguration einbinden.

Hinweis

Falls noch nicht geschehen, fügen Sie Ihrem Android-Projekt Firebase hinzu.

Wenn Sie keine anderen Firebase-Produkte verwenden, müssen Sie nur ein Projekt erstellen und Ihre App registrieren. Wenn Sie jedoch in Zukunft weitere Produkte verwenden möchten, müssen Sie alle Schritte auf der oben verlinkten Seite ausführen.

Schritt 1: Überholspur einrichten

  1. Schnelle Installation und Einrichtung

  2. Wenn Sie App Distribution Ihrer Fastlane-Konfiguration hinzufügen möchten, führen Sie den folgenden Befehl im Stammverzeichnis Ihres Android-Projekts aus:

    fastlane add_plugin firebase_app_distribution

    Wenn Sie beim Befehl eine Option sehen, wählen Sie Option 3: RubyGems.org aus.

Schritt 2: Mit Firebase authentifizieren

Bevor Sie das Fastlane-Plug-in verwenden können, müssen Sie sich auf eine der folgenden Arten bei Ihrem Firebase-Projekt authentifizieren. Standardmäßig sucht das Fastlane-Plug-in nach Anmeldedaten aus der Firebase CLI, wenn keine andere Authentifizierungsmethode verwendet wird.

Schritt 3: Fastfile einrichten und App bereitstellen

  1. Fügen Sie auf einer ./fastlane/Fastfile-Spur einen firebase_app_distribution-Block hinzu. Verwenden Sie die folgenden Parameter, um die Verteilung zu konfigurieren:
    Parameter „firebase_app_distribution“
    app

    Erforderlich: Die Firebase App-ID Ihrer App. Sie finden die App-ID in der Firebase Console auf der Seite Allgemeine Einstellungen.

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

    Ein Aktualisierungstoken, das ausgegeben wird, wenn Sie Ihre CI-Umgebung mit der Firebase CLI authentifizieren. Weitere Informationen finden Sie unter CLI mit CI-Systemen verwenden.

    service_credentials_file

    Der Pfad zur JSON-Datei Ihres Google-Dienstkontos. Eine Anleitung zum Authentifizieren mit Dienstkonto-Anmeldedaten finden Sie oben.

    android_artifact_type

    Gibt den Android-Dateityp an (APK oder AAB).

    android_artifact_path

    Ersetzt apk_path (eingestellt). Absoluter Pfad zur APK- oder AAB-Datei, die Sie hochladen möchten. Wenn Sie keinen Speicherort angeben, ermittelt fastlane den Speicherort der Datei anhand der Lane, in der die Datei generiert wurde.

    release_notes
    release_notes_file

    Versionshinweise für diesen Build.

    Sie können die Versionshinweise direkt angeben:

    release_notes: "Text of release notes"

    Oder geben Sie den Pfad zu einer Nur-Text-Datei an:

    release_notes_file: "/path/to/release-notes.txt"
    testers
    testers_file

    Die E-Mail-Adressen der Tester, die Sie einladen möchten.

    Sie können die Tester als durch Kommas getrennte Liste von E-Mail-Adressen angeben:

    testers: "ali@example.com, bri@example.com, cal@example.com"

    Sie können auch den Pfad zu einer Nur-Text-Datei angeben, die eine durch Kommas getrennte Liste von E-Mail-Adressen enthält:

    testers_file: "/path/to/testers.txt"
    groups
    groups_file

    Die Testergruppen, die Sie einladen möchten (siehe Tester verwalten). Gruppen werden mithilfe von Gruppenaliassen angegeben, die Sie in der Firebase-Konsole aufrufen können.

    Sie können die Gruppen als durch Kommas getrennte Liste angeben:

    groups: "qa-team, trusted-testers"

    Sie können auch den Pfad zu einer Nur-Text-Datei angeben, die eine durch Kommas getrennte Liste von Gruppennamen enthält:

    groups_file: "/path/to/groups.txt"
    test_devices
    test_devices_file

    Die folgenden Verteilungstypen sind Teil der Betafunktion „Automatischer Tester“.

    Die Testgeräte, auf die Sie Builds verteilen möchten (siehe Automatisierte Tests).

    Sie können die Testgeräte als durch Semikolons getrennte Liste von Testgeräten angeben:

    test_devices: "model=shiba,version=34,locale=en,orientation=portrait;model=b0q,version=33,locale=en,orientation=portrait"

    Alternativ können Sie den Pfad zu einer Nur-Text-Datei angeben, die eine durch Semikolons getrennte Liste von Testgeräten enthält:

    test_devices_file: "/path/to/test-devices.txt"
    test_username

    Der Nutzername für die automatische Anmeldung, der bei automatisierten Tests verwendet werden soll.

    test_password
    test_password_file

    Das Passwort für die automatische Anmeldung bei automatisierten Tests.

    Sie können auch den Pfad zu einer Nur-Text-Datei mit einem Passwort angeben:

    test_password_file: "/path/to/test-password.txt"
    test_username_resource

    Ressourcenname für das Feld „Nutzername“ für die automatische Anmeldung bei automatisierten Tests.

    test_password_resource

    Ressourcenname für das Passwortfeld für die automatische Anmeldung, der bei automatisierten Tests verwendet wird

    test_non_blocking

    Automatisierte Tests asynchron ausführen. Rufen Sie die Firebase Console auf, um die Ergebnisse des automatischen Tests zu sehen.

    debug

    Ein boolesches Flag. Sie können diesen Wert auf true setzen, um eine ausführliche Debug-Ausgabe zu erhalten.

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

Führen Sie die folgenden Schritte aus, um den Build für Tester verfügbar zu machen:

fastlane <lane>

Der Rückgabewert der Aktion ist ein Hash, der den hochgeladenen Release darstellt. Dieser Hash ist auch mit lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE] verfügbar. Weitere Informationen zu den verfügbaren Feldern in diesem Hash finden Sie in der Dokumentation zur REST API.

Das Fastlane-Plug-in gibt nach dem Upload der Veröffentlichung die folgenden Links aus. Mit diesen Links kannst du Binärdateien verwalten und dafür sorgen, dass Tester und andere Entwickler den richtigen Release haben:

  • Ein Link zur Firebase-Konsole mit einer einzelnen Version. Sie können diesen Link mit anderen Entwicklern in Ihrer Organisation teilen.
  • Ein Link zum Release in der Testeroberfläche (native Android-App), über den Tester Release-Notes aufrufen und die App auf ihrem Gerät installieren können. Der Tester benötigt Zugriff auf die Version, um den Link verwenden zu können.
  • Einen signierten Link, über den das App-Binärprogramm (APK- oder AAB-Datei) direkt heruntergeladen und installiert wird Der Link läuft nach einer Stunde ab.

Nachdem Sie Ihren Build bereitgestellt haben, ist er 150 Tage lang im App Distribution-Dashboard der Firebase-Konsole verfügbar. Wenn der Build 30 Tage nach dem Ablaufen abläuft, wird in der Console und in der Build-Liste des Testers auf dem Testgerät ein Ablaufhinweis angezeigt.

Tester, die noch nicht zum Testen der App eingeladen wurden, erhalten eine Einladung per E-Mail. Bestehende Tester erhalten eine E-Mail-Benachrichtigung, dass ein neuer Build zum Testen bereit ist. Informationen zum Installieren der Test-App finden Sie im Einrichtungsleitfaden für Tester. In der Firebase-Konsole können Sie den Status der einzelnen Tester prüfen, um festzustellen, ob sie die Einladung angenommen und die App heruntergeladen haben.

Optional: Wenn Sie die Build-Nummer jedes Mal automatisch erhöhen möchten, wenn Sie einen neuen Release in der App-Bereitstellung erstellen, können Sie die Aktion firebase_app_distribution_get_latest_release und beispielsweise das increment_version_code Fastlane-Plug-in verwenden. Im folgenden Codebeispiel wird gezeigt, wie die Build-Nummer automatisch erhöht wird:

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

Weitere Informationen zur Aktion firebase_app_distribution_get_latest_release findest du unter Informationen zum neuesten Release deiner App abrufen.

Schritt 4 (optional). Tester für die Verteilung verwalten

Du kannst Tester deinem Projekt oder deiner Gruppe hinzufügen und daraus entfernen. Verwende dazu die Datei Fastfile oder führe Schnellzugriffsaktionen aus. Wenn Sie Aktionen direkt ausführen, werden die in Fastfile festgelegten Werte überschrieben.

Nachdem ein Tester Ihrem Firebase-Projekt hinzugefügt wurde, können Sie ihn einzelnen Releases hinzufügen. Tester, die aus Ihrem Firebase-Projekt entfernt werden, haben keinen Zugriff mehr auf Releases in Ihrem Projekt. Sie behalten aber möglicherweise noch eine Zeit lang den Zugriff auf Ihre Releases.

Wenn Sie eine große Anzahl von Testern haben, sollten Sie Gruppen verwenden.

Fastfile verwenden

# 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-Aktionen ausführen

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"

Sie können Tester auch mit --file="/path/to/testers.txt anstelle von --emails angeben.

Die Aufgaben firebase_app_distribution_add_testers und firebase_app_distribution_remove_testers akzeptieren auch die folgenden Argumente:

  • project_name: Ihre Firebase-Projektnummer
  • group_alias (optional): Wenn angegeben, werden die Tester der angegebenen Gruppe hinzugefügt oder daraus entfernt.
  • service_credentials_file: Der Pfad zur Datei mit den Anmeldedaten für den Google-Dienst.
  • firebase_cli_token: Authentifizierungstoken für die Firebase-Befehlszeile.

service_credentials_file und firebase_cli_token sind dieselben Argumente, die von der Upload-Aktion verwendet werden.

Schritt 5 (optional): Informationen zur neuesten Version Ihrer App abrufen

Mit der Aktion firebase_app_distribution_get_latest_release können Sie Informationen zum neuesten Release Ihrer App in der App-Distribution abrufen, einschließlich Informationen zur App-Version, Versionshinweisen und Erstellungszeit. Anwendungsfälle umfassen das automatische Erhöhen der Version und das Übertragen der Release-Notes aus dem vorherigen Release.

Der Rückgabewert der Aktion ist ein Hashwert, der den neuesten Release darstellt. Dieser Hash ist auch mit lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE] verfügbar. Weitere Informationen zu den verfügbaren Feldern in diesem Hash finden Sie in der REST API-Dokumentation.

Parameter

Parameter für „firebase_app_distribution_get_latest_release“
app

Erforderlich: Die Firebase-App-ID Ihrer App. Sie finden die App-ID in der Firebase-Konsole auf der Seite Allgemeine Einstellungen.

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

Ein Aktualisierungstoken, das ausgegeben wird, wenn Sie Ihre CI-Umgebung mit der Firebase-Befehlszeile authentifizieren. Weitere Informationen finden Sie unter Befehlszeile mit CI-Systemen verwenden.

service_credentials_file

Der Pfad zur JSON-Datei Ihres Google-Dienstkontos. Wie Sie sich mit den Anmeldedaten eines Dienstkontos authentifizieren, wird oben beschrieben.

debug

Ein boolesches Flag. Sie können diese Einstellung auf true setzen, um eine ausführliche Debug-Ausgabe auszugeben.

Nächste Schritte