Skip to main content

Deploying Android apps to Bitrise and Google Play

Abstract

You can deploy your Android apps to Bitrise or to Google Play by using our dedicated Steps and correctly configuring your project in Google Play Console.

This guide describes how you can add your Android project to bitrise.io and deploy the APK or AAB built from your project to Google Play Store.

You need a new service account created in the Google Play Console so that Bitrise can authenticate with Google Play Deploy during your build. The new service account has to be invited to Google Play Console as a user with the appropriate permission.

To set up your project for the first time:

  1. Register a Google Play Developer Account. If you already have a Google Play Developer account, and have already deployed your app to Google Play Store, skip to Setting up Google Play API access.

  2. Go through Setting up Google Play deployment for the first time.

Setting up Google Play API access

Grant the Google Play API access to your project by either creating a new API project or linking an existing API project. In this tutorial, we’re creating a new one.

  1. Go to your Google Play Console and click Settings. Click API access on the left menu bar. On the Linked Google Cloud project page, select Create new project option.

    apiaccessstart.jpg

  2. On the API access page, scroll down to Service accounts and click Create a new service account. Follow the instructions to get to Google Cloud Platform.

    createnewserviceaccount.jpg

  3. On the Google Cloud Platform, click + CREATE SERVICE ACCOUNT on the top menu bar.

    pluscreateserviceaccount.jpg

  4. A 3-step Create service account page comes up, where you have to provide a Service account name first. A Service account ID is automatically generated based on the Service account name you typed.

    serviceaccountdetails.jpg

  5. At the Grant this service account access to project step, select Browser in the Role dropdown. Although the second and third steps of the process are marked optional on Google Cloud Platform, those are essential for Bitrise to be able to use the service account access.

    serviceaccountdetails.png

  6. Fill out the Service account user role and Service account admins role fields of the Grant users access to this service account step. Hit DONE.

    grantuseraccess.jpg

  7. You land back on the API Access page of the Google Play Console where you can create a key to your new service account. Bitrise will use the key to authenticate as the service account. Click the ellipsis next to the new service account and select Manage keys from the options.

    managekeys.jpg

  8. You are directed to the KEYS page of the Service accounts. Click the ADD KEY dropdown and select Create new key option.

    createnewkey.jpg

  9. Select JSON as your Key type. Click CREATE. Once you created a key here, it automatically downloads to your local machine and you can upload it to the Code Signing tab of Bitrise. You may close your Google Cloud Platform window as we won’t need it any more.

    jsonkey-png.jpg

  10. You are landing back on the API access page of Google Play Console where you can see your new service account under Service accounts. Click Grant access to link your project to the Google Console. The Google Cloud Platform (GCP) service account will be invited as a user to the Google Play Console, so GCP will have access to your apps in Play Console. Bitrise uses this service account to make changes in the Google Play Console.

    grantaccess.jpg

  11. In the Invite user window, the Email address field is pre-filled. Under Permissions, the default ones are already selected. You can go with these. Click Invite user at the bottom of the page.

    permission.jpg

Check out the Google Play Developer API guide if you need more information on the process.

You have successfully prepared your Google Play Console project. A services credential account has been created which is authorized to manage your releases.

Setting up Google Play deployment for the first time

Deploying to Google play publishes your app to Google's online store. When you do it for the first time, this requires a bit more work than simply deploying to bitrise.io. Once the necessary configurations are in place, it becomes very simple.

When configuring Google Play deployment for the first time, you need to link your Google Play Developer account to an API project, set up API access, and upload the service account JSON key to Bitrise.

  1. Upload the first AAB or APK manually to Google Play using the Google Play Console.

  2. Link your Google Play Developer Console to an API project.

  3. Set up API Access Clients using a service account: Please note when you create your service account on the Google Developer Console, you have to choose json as Key Type.

  4. Grant the necessary rights to the service account with your Google Play Console. Go to Settings, then Users & permissions, then Invite new user. Due to the way the Google Play Publisher API works, you have to grant at least the following permissions to the service account:

    • Access level: View app information.

    • Release management: Manage production releases, manage testing track releases.

    • Store presence: Edit store listing, pricing & distribution.

  5. As an optional step, you can add translations to your Store Listing: Translate & localize your app.

  6. Upload the service account JSON key to the Generic File Storage.

Deploying an Android app to bitrise.io

In this section, we'll go through how to deploy your Android app to bitrise.io.

Deploying to bitrise.io means that the build artifacts generated during the build will be available for download once the build is finished. You can use this to test your app on your own test devices, for example.

To deploy your app to bitrise.io:

Workflow Editor

bitrise.yml

  1. Make sure your Workflow contains the Android Build Step to build your app.

    Optionally, you can build your app with the Gradle Runner Step. This requires a bit more configuration from you but allows for more extensive customization.

  2. Add the Deploy to Bitrise.io Step to your Workflow.

    Notifying other users

    You can use the Notify: User Roles and the Notify: Emails inputs of the Step to set up notifications about your deploy. Click the input names to reveal more information about how to configure them.

  3. Optionally, set the Enable public page for the App? input of the Step to true so the Step enables the public install page for your app.

  4. Run a build.

  1. Open the bitrise.yml file of your app.

  2. Make sure your Workflow contains the android-build Step to build your app.

    workflows:
  example-workflow:
    steps:
    - android-build@1:

    Optionally, you can build your app with the gradle-runner Step. This requires a bit more configuration from you but allows for more extensive customization.

  3. Set the module and/or variant input to tell the Step what to build.

    In this example, we're building a debug variant of the Android project.

    workflows:
  example-workflow:
    steps:
    - android-build@1:
        inputs:
        - variant: debug
    - deploy-to-bitrise-io: {}

  4. Add the deploy-to-bitrise-io Step to your Workflow.

    workflows:
  example-workflow:
    steps:
    - android-build@1:
        inputs:
        - variant: debug
    - deploy-to-bitrise-io: {}

    Notifying other users

    You can use the notify_user_groups and the notify_email_list inputs of the Step to set up notifications about your deploy:

    • The notify_user_groups input allows you to send notifications based on the access roles granted to users. For example, you can set the input to notify everyone with an Admin and a Developer role. Set multiple roles separated by a comma: - notify_user_groups: admins, testers.

    • The notify_email_list input only accepts Secrets, and the Secret should contain comma-separated lists of email addresses.

  5. Optionally, set the Enable public page for the App? input of the Step to true so the Step enables the public install page for your app.

  6. Run a build.

The Deploy to Bitrise.io Step will deploy the app. You can share the generated binary with your team members using the build’s URL.

Example 1. A bitrise.yml for deploying an Android app to Bitrise

In this example, we're building the debug variant of an Android app, and deploy it to bitrise.io, as.


Deploying to Google Play

Deploying to Google Play requires a signed APK or AAB file and the Google Play Deploy Step.

Workflow Editor

bitrise.yml

  1. If you're trying to deploy your app for the first time, make sure your Google Play configuration is set up correctly and that you uploaded your service account JSON key to Bitrise.

    Uploading the service account JSON key file

    We recommend uploading the service account JSON key to Bitrise but it is not mandatory: you can store it elsewhere and provide a direct link to it.

  2. Open the Workflow Editor, and go to the Code Signing & Files tab.

  3. In the Generic File Storage, find the uploaded service account JSON key and copy the secret Env Var under its name.

    For example, BITRISEIO_SERVICE_ACCOUNT_JSON_KEY_URL.

  4. Open your Workflow and add the Google Play Deploy Step to it.

  5. In the Service Account JSON key file path input, paste the Environment Variable you copied.

    Direct path to the service account JSON key file

    If you don't want to upload the service account JSON key to Bitrise, you can also add a file path right in the Step’s input field where the file path can be local or remote too:

    • For a remote JSON key file you can provide any download location as value, for example, https://URL/TO/key.json.

    • For a local JSON key file you can provide a file path url as value, for example, file://PATH/TO/key.json.

  6. In the Package name input, add the package name of your app.

  7. In the Track input, add the track where you want to deploy your APK (for example, alpha/beta/rollout/production or any custom track you set).

  1. If you're trying to deploy your app for the first time, make sure your Google Play configuration is set up correctly and that you uploaded your service account JSON key to Bitrise.

    Uploading the service account JSON key file

    We recommend uploading the service account JSON key to Bitrise but it is not mandatory: you can store it elsewhere and provide a direct link to it.

  2. Open your app's bitrise.yml file and add the google-play-deploy Step to it.

    deploy-workflow:
  steps: 
  - google-play-deploy: 
      inputs:

  3. In the service_account_json_key_path input, you need to provide the path to the service account JSON key file.

    If you uploaded the file to Bitrise, you can find the Env Var storing its download URL in the Generic File Storage in the Workflow Editor.

    deploy-workflow:
  steps: 
  - google-play-deploy: 
      inputs:   
      - service_account_json_key_path: "$BITRISEIO_SERVICE_ACCOUNT_JSON_KEY_URL"

    If you didn't upload your service account JSON key to Bitrise, you can set a direct path in the input. The file path can point to a local or a remote location.

    • For a remote JSON key file you can provide any download location as value, for example, https://URL/TO/key.json.

    • For a local JSON key file you can provide a file path url as value, for example, file://PATH/TO/key.json.

  4. In the package input, add the package name of your app.

    deploy-workflow:
  steps: 
  - google-play-deploy: 
      inputs:   
      - service_account_json_key_path: "$BITRISEIO_SERVICE_ACCOUNT_JSON_KEY_URL"
      - package_name: myApp

  5. In the track input, add the track where you want to deploy your app binary (for example, alpha/beta/rollout/production or any custom track you set).

    deploy-workflow:
  steps: 
  - google-play-deploy: 
      inputs:   
      - service_account_json_key_path: "$BITRISEIO_SERVICE_ACCOUNT_JSON_KEY_URL"
      - package_name: myApp
      - track: alpha

That’s all! Start or schedule a build and share the URL with external testers or distribute your app on an app store of your choice!

In this section:

An app on Bitrise represents a Git repository that stores source code and has been connected to Bitrise to be able to run builds on it. As such, a Bitrise app isn't necessarily an actual application: it's just the code on which you run builds with Bitrise.

A Workflow is a collection of Steps, Environment Variables, and other configurations. When Bitrise starts a build, it runs one or more Workflows according to the configuration defined in the bitrise.yml file.

A Step is a block of script execution that encapsulates a build task on Bitrise: the code to perform that task, the inputs and parameters you can define for the task, and the outputs the task generates.

A Workflow is a collection of Steps, Environment Variables, and other configurations. When Bitrise starts a build, it runs one or more Workflows according to the configuration defined in the bitrise.yml file.

A Step is a block of script execution that encapsulates a build task on Bitrise: the code to perform that task, the inputs and parameters you can define for the task, and the outputs the task generates.

A Step is a block of script execution that encapsulates a build task on Bitrise: the code to perform that task, the inputs and parameters you can define for the task, and the outputs the task generates.

An app on Bitrise represents a Git repository that stores source code and has been connected to Bitrise to be able to run builds on it. As such, a Bitrise app isn't necessarily an actual application: it's just the code on which you run builds with Bitrise.

A Workflow is a collection of Steps, Environment Variables, and other configurations. When Bitrise starts a build, it runs one or more Workflows according to the configuration defined in the bitrise.yml file.

An app on Bitrise represents a Git repository that stores source code and has been connected to Bitrise to be able to run builds on it. As such, a Bitrise app isn't necessarily an actual application: it's just the code on which you run builds with Bitrise.