Distribuya aplicaciones de Android a los evaluadores mediante fastlane

Este documento describe cómo distribuir compilaciones de APK a evaluadores utilizando fastlane , una plataforma de código abierto que automatiza la creación y lanzamiento de aplicaciones para iOS y Android. Este documento sigue las instrucciones definidas en un Fastfile . Después de configurar fastlane y Fastfile , puede integrar App Distribution con su configuración de fastlane.

Antes de que empieces

Si aún no lo has hecho, agrega Firebase a tu proyecto de Android .

Si no estás utilizando ningún otro producto de Firebase, solo tienes que crear un proyecto y registrar tu aplicación. Sin embargo, si decide utilizar productos adicionales en el futuro, asegúrese de completar todos los pasos en la página vinculada anteriormente.

Paso 1. Configurar fastlane

  1. Instalar y configurar fastlane .

  2. Para agregar App Distribution a su configuración de fastlane, ejecute el siguiente comando desde la raíz de su proyecto de Android:

    fastlane add_plugin firebase_app_distribution

    Si el comando le solicita una opción, seleccione Option 3: RubyGems.org .

Paso 2. Autenticarse con Firebase

Antes de poder usar el complemento fastlane, primero debes autenticarte en tu proyecto de Firebase de una de las siguientes maneras. De forma predeterminada, el complemento fastlane busca credenciales de Firebase CLI si no se utiliza ningún otro método de autenticación.

Paso 3. Configura tu Fastfile y distribuye tu aplicación

  1. En un carril ./fastlane/Fastfile , agregue un bloque firebase_app_distribution . Utilice los siguientes parámetros para configurar la distribución:
    Parámetros de firebase_app_distribution
    app

    Requerido : el ID de la aplicación Firebase de tu aplicación. Puede encontrar el ID de la aplicación en Firebase console, en la página Configuración general .

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

    Un token de actualización que se imprime cuando autenticas tu entorno de CI con Firebase CLI (lee Usar la CLI con sistemas de CI para obtener más información).

    service_credentials_file

    La ruta al archivo json de su cuenta de servicio de Google. Consulte arriba para saber cómo autenticarse utilizando las credenciales de la cuenta de servicio .

    android_artifact_type

    Especifica el tipo de archivo de Android (APK o AAB).

    android_artifact_path

    Reemplaza apk_path (obsoleto). Ruta absoluta al archivo APK o AAB que deseas cargar. Si no se especifica, fastlane determina la ubicación del archivo a partir del carril en el que se generó el archivo.

    release_notes
    release_notes_file

    Notas de la versión para esta compilación.

    Puede especificar las notas de la versión directamente:

    release_notes: "Text of release notes"

    O especifique la ruta a un archivo de texto sin formato:

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

    Las direcciones de correo electrónico de los evaluadores que desea invitar.

    Puede especificar los evaluadores como una lista de direcciones de correo electrónico separadas por comas:

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

    O puede especificar la ruta a un archivo de texto sin formato que contenga una lista de direcciones de correo electrónico separadas por comas:

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

    Los grupos de testers que desea invitar (consulte Administrar testers ). Los grupos se especifican usando alias de grupo , que puedes buscar en Firebase console.

    Puede especificar los grupos como una lista separada por comas:

    groups: "qa-team, trusted-testers"

    O puede especificar la ruta a un archivo de texto sin formato que contenga una lista de nombres de grupos separados por comas:

    groups_file: "/path/to/groups.txt"
    debug

    Una bandera booleana. Puede establecer esto en true para imprimir una salida de depuración detallada.

    test_devices
    test_devices_file

    Los siguientes tipos de distribución forman parte de la función beta del probador automatizado .

    Los dispositivos de prueba a los que desea distribuir compilaciones (consulte Pruebas automatizadas ).

    Puede especificar los dispositivos de prueba como una lista de dispositivos de prueba separados por punto y coma:

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

    O puede especificar la ruta a un archivo de texto sin formato que contenga una lista de dispositivos de prueba separados por punto y coma:

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

    El nombre de usuario para el inicio de sesión automático que se utilizará durante las pruebas automatizadas .

    test_password
    test_password_file

    La contraseña para el inicio de sesión automático que se utilizará durante las pruebas automatizadas .

    O puede especificar la ruta a un archivo de texto sin formato que contenga una contraseña:

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

    Nombre del recurso para el campo de nombre de usuario para el inicio de sesión automático que se utilizará durante las pruebas automatizadas .

    test_password_resource

    Nombre del recurso para el campo de contraseña para el inicio de sesión automático que se utilizará durante las pruebas automatizadas .

    test_non_blocking

    Ejecute pruebas automatizadas de forma asincrónica. Visite la consola de Firebase para ver los resultados de las pruebas automáticas.

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

Para que la compilación esté disponible para los evaluadores, ejecute su carril:

fastlane <lane>

El valor de retorno de la acción es un hash que representa la versión cargada. Este hash también está disponible usando lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE] . Para obtener más información sobre los campos disponibles en este hash, consulte la documentación de la API REST .

El complemento fastlane genera los siguientes enlaces después de la carga del lanzamiento. Estos enlaces lo ayudan a administrar archivos binarios y garantizar que los evaluadores y otros desarrolladores tengan la versión correcta:

  • Un enlace a Firebase console que muestra una versión única. Puede compartir este enlace con otros desarrolladores de su organización.
  • Un enlace a la versión en la experiencia del evaluador (aplicación nativa de Android) que permite a los evaluadores ver las notas de la versión e instalar la aplicación en su dispositivo. El evaluador necesita acceso a la versión para poder utilizar el enlace.
  • Un enlace firmado que descarga e instala directamente el binario de la aplicación (archivo APK o AAB). El enlace caduca después de una hora.

Después de distribuir su compilación, estará disponible en el panel de distribución de aplicaciones de Firebase console durante 150 días. Cuando faltan 30 días para que expire la compilación, aparece un aviso de vencimiento en la consola y en la lista de compilaciones del evaluador en su dispositivo de prueba.

Los evaluadores que no fueron invitados previamente a probar la aplicación reciben invitaciones por correo electrónico para comenzar. Los evaluadores existentes reciben notificaciones por correo electrónico de que una nueva versión está lista para probar. Para saber cómo instalar la aplicación de prueba, consulte la guía de configuración del probador . Puede monitorear el estado de cada tester para determinar si aceptaron la invitación y si descargaron la aplicación en Firebase console.

(Opcional) Para incrementar automáticamente su número de compilación cada vez que crea una nueva versión en App Distribution, puede usar la acción firebase_app_distribution_get_latest_release y, por ejemplo, el complemento fastlane increment_version_code . El siguiente código proporciona un ejemplo de cómo incrementar automáticamente su número de compilación:

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

Para obtener más información sobre la acción firebase_app_distribution_get_latest_release , consulta Obtener información sobre la última versión de tu aplicación .

Paso 4 (Opcional). Gestión de testers para la distribución.

Puede agregar y eliminar evaluadores de su proyecto o grupo usando su archivo Fastfile o ejecutando acciones fastlane directamente. La ejecución de acciones anula directamente los valores establecidos en su Fastfile .

Una vez que se agrega un tester a su proyecto de Firebase, puede agregarlo a versiones individuales. Los testers que son eliminados de tu proyecto de Firebase ya no tienen acceso a las versiones de tu proyecto, pero pueden conservar el acceso a tus versiones durante un período de tiempo.

Si tiene una gran cantidad de evaluadores, debería considerar el uso de grupos.

Usar 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

Ejecutar acciones 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"

También puede especificar evaluadores usando --file="/path/to/testers.txt en lugar de --emails .

Las tareas firebase_app_distribution_add_testers y firebase_app_distribution_remove_testers también aceptan los siguientes argumentos:

  • project_name : el número de tu proyecto de Firebase.
  • group_alias (opcional): si se especifica, los evaluadores se agregan (o se eliminan) al grupo especificado.
  • service_credentials_file : la ruta a su archivo de credenciales de servicio de Google.
  • firebase_cli_token : token de autenticación para Firebase CLI.

service_credentials_file y firebase_cli_token son los mismos argumentos utilizados por la acción de carga.

Paso 5 (Opcional). Obtenga información sobre la última versión de su aplicación

Puedes usar la acción firebase_app_distribution_get_latest_release para obtener información sobre la última versión de tu aplicación en App Distribution, incluida información de la versión de la aplicación, notas de la versión y hora de creación. Los casos de uso incluyen aumentar automáticamente la versión y transferir las notas de la versión anterior.

El valor de retorno de la acción es un hash que representa la última versión. Este hash también está disponible usando lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE] . Para obtener más información sobre los campos disponibles en este hash, consulte la documentación de la API REST .

Parámetros

parámetros firebase_app_distribution_get_latest_release
app

Requerido : el ID de la aplicación Firebase de tu aplicación. Puede encontrar el ID de la aplicación en Firebase console, en la página Configuración general .

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

Un token de actualización que se imprime cuando autenticas tu entorno de CI con Firebase CLI (lee Usar la CLI con sistemas de CI para obtener más información).

service_credentials_file

La ruta al archivo json de su cuenta de servicio de Google. Consulte arriba para saber cómo autenticarse utilizando las credenciales de la cuenta de servicio .

debug

Una bandera booleana. Puede establecer esto en true para imprimir una salida de depuración detallada.

Próximos pasos