Distribua aplicativos Android para testadores usando Gradle

Você pode integrar o App Distribution ao processo de construção do Android usando o plug-in App Distribution Gradle. O plug-in permite especificar seus testadores e notas de lançamento no arquivo Gradle do seu aplicativo, permitindo configurar distribuições para diferentes tipos de compilação e variantes do seu aplicativo.

Este guia descreve como distribuir APKs para testadores usando o plug-in App Distribution Gradle.

Antes de você começar

Adicione o Firebase ao seu projeto Android , caso ainda não o tenha feito.

Se você não estiver usando nenhum outro produto Firebase, basta criar um projeto e registrar seu aplicativo. No entanto, se você decidir usar produtos adicionais no futuro, certifique-se de concluir todas as etapas da página com link acima.

Passo 1. Configure seu projeto Android

  1. Em seu arquivo Gradle de nível raiz (nível de projeto) ( <project>/build.gradle.kts ou <project>/build.gradle ), adicione o plug-in App Distribution Gradle como uma dependência:

    Kotlin

    plugins {
    // ...
    id("com.android.application") version "7.3.0" apply false

    // Make sure that you have the Google services Gradle plugin dependency
    id("com.google.gms.google-services") version "4.4.1" apply false

    // Add the dependency for the App Distribution Gradle plugin
    id("com.google.firebase.appdistribution") version "4.2.0" apply false
}

    Groovy

    plugins {
    // ...
    id 'com.android.application' version '7.3.0' apply false

    // Make sure that you have the Google services Gradle plugin dependency
    id 'com.google.gms.google-services' version '4.4.1' apply false

    // Add the dependency for the App Distribution Gradle plugin
    id 'com.google.firebase.appdistribution' version '4.2.0' apply false
}

  2. No arquivo Gradle do módulo (nível do aplicativo) (geralmente <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle ), adicione o plug-in App Distribution Gradle:

    Kotlin

    plugins {
  id("com.android.application")

  // Make sure that you have the Google services Gradle plugin
  id("com.google.gms.google-services")

  // Add the App Distribution Gradle plugin
  id("com.google.firebase.appdistribution")
}

    Groovy

    plugins {
  id 'com.android.application'

  // Make sure that you have the Google services Gradle plugin
  id 'com.google.gms.google-services'

  // Add the App Distribution Gradle plugin
  id 'com.google.firebase.appdistribution'
}

  3. Se você estiver protegido por um proxy ou firewall corporativo, adicione a seguinte propriedade de sistema Java que permite que o App Distribution faça upload de suas distribuições para o Firebase:

    -Djavax.net.ssl.trustStore=/path/to/truststore -Djavax.net.ssl.trustStorePassword=password

Etapa 2. Autenticar com Firebase

Antes de usar o plug-in Gradle, você deve primeiro autenticar seu projeto do Firebase de uma das seguintes maneiras. Por padrão, o plug-in Gradle procura credenciais na CLI do Firebase se nenhum outro método de autenticação for usado.

Etapa 3. Configure suas propriedades de distribuição

No arquivo Gradle do módulo (nível do aplicativo) (geralmente <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle ), configure o App Distribution adicionando pelo menos uma seção firebaseAppDistribution .

Por exemplo, para distribuir a versão release aos testadores, siga estas instruções::

Kotlin

import com.google.firebase.appdistribution.gradle.firebaseAppDistribution

android {

  // ...

  buildTypes {
      getByName("release") {
          firebaseAppDistribution {
              artifactType = "APK"
              releaseNotesFile = "/path/to/releasenotes.txt"
              testers = "ali@example.com, bri@example.com, cal@example.com"
          }
      }
  }

  // ...
}

Groovy

android {

  // ...

  buildTypes {
      release {
          firebaseAppDistribution {
              artifactType="APK"
              releaseNotesFile="/path/to/releasenotes.txt"
              testers="ali@example.com, bri@example.com, cal@example.com"
          }
      }
  }

  // ...
}

Você pode configurar o App Distribution para tipos de compilação e variações de produtos .

Por exemplo, para distribuir compilações debug e release em versões de produto "demo" e "completo", siga estas instruções:

Kotlin

import com.google.firebase.appdistribution.gradle.firebaseAppDistribution

android {

  // ...

  buildTypes {
      getByName("debug") {...}
      getByName("release") {...}
  }

  flavorDimensions += "version"
  productFlavors {
      create("demo") {
          dimension = "version"
          firebaseAppDistribution {
              releaseNotes = "Release notes for demo version"
              testers = "demo@testers.com"
          }
      }
      create("full") {
          dimension = "version"
          firebaseAppDistribution {
              releaseNotes = "Release notes for full version"
              testers = "full@testers.com"
          }
      }
  }

  // ...
}

Groovy

android {

  // ...

  buildTypes {
      debug {...}
      release {...}
  }

  flavorDimensions "version"
  productFlavors {
      demo {
          dimension "version"
          firebaseAppDistribution {
              releaseNotes="Release notes for demo version"
              testers="demo@testers.com"
          }
      }
      full {
          dimension "version"
          firebaseAppDistribution {
              releaseNotes="Release notes for full version"
              testers="full@testers.com"
          }
      }
  }

  // ...
}

Use os seguintes parâmetros para configurar a distribuição:

Parâmetros de compilação de distribuição de aplicativos
appId

O ID do aplicativo Firebase do seu aplicativo. Obrigatório apenas se você não tiver o plug-in Gradle do Google Services instalado. Você pode encontrar o ID do aplicativo no arquivo google-services.json ou no console do Firebase na página Configurações gerais . O valor em seu arquivo build.gradle substitui o valor gerado pelo plug-in google-services .

appId="1:1234567890:android:321abc456def7890"
serviceCredentialsFile

O caminho para o arquivo JSON da chave privada da sua conta de serviço. Obrigatório apenas se você usar autenticação de conta de serviço.

artifactType

Especifica o tipo de arquivo do seu aplicativo. Pode ser definido como "AAB" ou "APK" .

artifactPath

Caminho absoluto para o arquivo APK ou AAB que você deseja enviar.

releaseNotes ou releaseNotesFile

Notas de versão para esta compilação.

Você pode especificar as notas de versão diretamente ou o caminho para um arquivo de texto simples.

testers ou testersFile

Os endereços de e-mail dos testadores para os quais você deseja distribuir compilações.

Você pode especificar os testadores como uma lista de endereços de e-mail separados por vírgulas:

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

Ou você pode especificar o caminho para um arquivo que contém uma lista de endereços de e-mail separados por vírgulas:

testersFile="/path/to/testers.txt"
groups ou groupsFile

Os grupos de testadores para os quais você deseja distribuir compilações (consulte Gerenciar testadores ). Os grupos são especificados usando aliases de grupo , que você pode encontrar na guia Testadores no console do Firebase App Distribution.

Você pode especificar os grupos como uma lista separada por vírgulas de aliases de grupo:

groups="qa-team, android-testers"

Ou você pode especificar o caminho para um arquivo que contém uma lista de aliases de grupo separados por vírgulas:

groupsFile="/path/to/tester-groups.txt"
testDevices ou testDevicesFile

Os seguintes tipos de distribuição fazem parte do recurso Beta do testador automatizado .

Os dispositivos de teste para os quais você deseja distribuir compilações (consulte Testes automatizados ).

Você pode especificar os dispositivos de teste como uma lista de especificações de dispositivos separadas por ponto e vírgula:

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

Ou você pode especificar o caminho para um arquivo que contém uma lista de especificações de dispositivos separadas por ponto e vírgula:

testDevicesFile="/path/to/testDevices.txt"
testUsername

O nome de usuário para login automático a ser usado durante testes automatizados .

testPassword ou testPasswordFile

A senha para login automático a ser utilizada durante testes automatizados .

Ou você pode especificar o caminho para um arquivo de texto simples contendo uma senha:

testPasswordFile="/path/to/testPassword.txt"
testUsernameResource

Nome do recurso para o campo de nome de usuário para login automático a ser usado durante testes automatizados .

testPasswordResource

Nome do recurso do campo de senha para login automático a ser utilizado durante testes automatizados .

testNonBlocking

Execute testes automatizados de forma assíncrona. Visite o console do Firebase para ver os resultados dos testes automáticos.

stacktrace

Imprime o stacktrace para exceções do usuário. Isso é útil ao depurar problemas.

Etapa 4. Distribua seu aplicativo aos testadores

  1. Por fim, para empacotar seu aplicativo de teste e convidar testadores, crie os destinos BUILD-VARIANT e appDistributionUpload BUILD-VARIANT com o wrapper Gradle do seu projeto, onde BUILD-VARIANT é o tipo de produto opcional e o tipo de compilação que você configurou na etapa anterior. Para obter mais informações sobre variações de produtos, consulte Configurar variantes de build .

    Por exemplo, para distribuir seu aplicativo usando a variante de build release , execute o seguinte comando:

    ./gradlew assembleRelease appDistributionUploadRelease

    Ou, se você se autenticou com sua Conta do Google e não forneceu credenciais no arquivo de compilação do Gradle, inclua a variável FIREBASE_TOKEN :

    export FIREBASE_TOKEN=1/a1b2c3d4e5f67890
./gradlew --stop // Only needed for environment variable changes
./gradlew assembleRelease appDistributionUploadRelease

  2. Você também pode substituir os valores definidos em seu arquivo build.gradle passando argumentos de linha de comando na forma de --<property-name>=<property-value> . Por exemplo:

    • Para fazer upload de uma compilação de depuração para o App Distribution:

      ./gradlew bundleDebug appDistributionUploadDebug
    --artifactType="APK"

    • Para convidar testadores adicionais ou remover testadores existentes do seu projeto do Firebase:

      ./gradlew appDistributionAddTesters
    --projectNumber=<project_number>
    --emails="anothertester@email.com, moretesters@email.com"
./gradlew appDistributionRemoveTesters
    --projectNumber=<project_number>
    --emails="anothertester@email.com, moretesters@email.com"

      Depois que um testador for adicionado ao seu projeto do Firebase, você poderá adicioná-lo a versões individuais. Os testadores removidos não terão mais acesso às versões do seu projeto, mas ainda poderão manter o acesso às suas versões por um período de tempo.

    Você também pode especificar testadores usando --file="/path/to/testers.txt" em vez de --emails .

    As tarefas appDistributionAddTesters e appDistributionRemoveTesters também aceitam os seguintes argumentos:

    • projectNumber : o número do seu projeto do Firebase.

    • serviceCredentialsFile : o caminho para o arquivo de credenciais de serviço do Google. Este é o mesmo argumento usado pela ação de upload.

O plug-in Gradle gera os seguintes links após o upload da versão. Esses links ajudam você a gerenciar binários e garantir que os testadores e outros desenvolvedores tenham a versão correta:

  • firebase_console_uri – um link para o console do Firebase exibindo uma única versão. Você pode compartilhar esse link com outros desenvolvedores da sua organização.
  • testing_uri – Um link para o lançamento na experiência do testador (aplicativo nativo do Android) que permite aos testadores visualizar as notas de lançamento e instalar o aplicativo em seus dispositivos. O testador precisa de acesso à versão para usar o link.
  • binary_download_uri - Um link assinado que baixa e instala diretamente o binário do aplicativo (arquivo APK ou AAB). O link expira após uma hora.

Depois de distribuir sua versão, ela ficará disponível no painel de distribuição de aplicativos do console do Firebase por 150 dias (cinco meses). Quando faltam 30 dias para a expiração da compilação, um aviso de expiração aparece no console e na lista de compilações do testador no dispositivo de teste.

Os testadores que não foram convidados para testar o aplicativo recebem convites por email para começar, e os testadores existentes recebem notificações por email de que uma nova compilação está pronta para ser testada (leia o guia de configuração do testador para obter instruções sobre como instalar o aplicativo de teste). Você pode monitorar o status de cada testador (se eles aceitaram o convite e se fizeram o download do aplicativo) no Console do Firebase.

Os testadores têm 30 dias para aceitar um convite para testar o aplicativo antes que ele expire. Quando faltam cinco dias para a expiração de um convite, um aviso de expiração aparece no Console do Firebase ao lado do testador em uma versão. Um convite pode ser renovado reenviando-o usando o menu suspenso na linha do testador.

Próximos passos