Android code signing in Gradle

Configuring manually in Gradle ⚓

You can manually specify the code signing configuration in your Gradle configuration so that your app gets signed during the build process.

Open your module-level build.gradle file.
Add the signingConfigs codeblock to your code and define the following entries specific to your project: storeFile, storePassword, keyAlias, and keyPassword.
Attach the signing config to a build type.

Example signing configuration:

android {
   // Make sure signingConfigs is defined before buildTypes.
   signingConfigs { 
   	   release { 
       	 keyAlias 'MyAndroidKey' 
         keyPassword '***' 
         storeFile file("/path/to/my/keystore.jks") 
         storePassword '***' 
       } 
   } 
  

  buildTypes {
      release {
          // Use signing config for build type
          signingConfig signingConfigs.release
          // ...
      }
  }
  // ...

For more information, check out how to configure Gradle to sign your app.

About environment variables ⚓

You can avoid having the same keystore path locally and on bitrise.io by using configuration values and Environment Variables in the keystore path (storeFile) and in the keystore password.

If your keystore path is $HOME/keystores/my_keystore.jks, then your build.gradle file looks like this:

android { 
   signingConfigs { 
   	   release { 
       	 keyAlias 'MyAndroidKey' 
         keyPassword '***' 
         storeFile file(System.getenv("HOME") + "/keystores/my_keystore.jks")
         storePassword '***' 
       } 
   } ...

You can use the System.getenv("ENV_KEY") file to access Environment Variables in the Gradle config file.

Add the file downloader step to download the keystore:

- file-downloader@1:
    inputs:
    - destination: "$HOME/keystores/my_keystore.jks"
    - source: "$BITRISEIO_ANDROID_KEYSTORE_URL"
- gradle-runner@1:
    inputs:
    - gradle_task: assembleRelease
    - gradlew_path: "./gradlew"

If you use Environment Variables as keyPassword and storePassword in the Code signing tab, your build.gradle will look like this:

android {
   signingConfigs {
       release {
         keyAlias System.getenv("BITRISEIO_ANDROID_KEYSTORE_ALIAS")
         keyPassword System.getenv("BITRISEIO_ANDROID_KEYSTORE_PRIVATE_KEY_PASSWORD")
         storeFile file(System.getenv("HOME") + "/keystores/my_keystore.jks")
         storePassword System.getenv("BITRISEIO_ANDROID_KEYSTORE_PASSWORD")
       }
   }
   
   buildTypes {
      release {
          // Use signing config for build type
          signingConfig signingConfigs.release
          // ...
      }
   }
   ...

You get these Environment Variables when you upload your keystore to the GENERIC FILE STORAGE field of the Code Signing tab in your Workflow Editor.

Define the used Environment Variables

Do not forget to define the used Environment Variables on bitrise.io as well.

When you upload a keystore file in the Android keystore file section and you have all the fields filled out, Bitrise will export these Environment Variables automatically.

BITRISEIO_ANDROID_KEYSTORE_ALIAS
BITRISEIO_ANDROID_KEYSTORE_PASSWORD
BITRISEIO_ANDROID_KEYSTORE_PRIVATE_KEY_PASSWORD
BITRISEIO_ANDROID_KEYSTORE_URL

You can upload, update, list, and delete iOS code signing files with the relevant Bitrise API. In this guide we show you how and in what order to use those...

Before you distribute your app through Google Play Store, your APK file must be digitally signed. Find out the different ways of signing your Android app on Bitrise.

You can create a signed APK using the Android Sign Step in your Bitrise workflow. This Step is configured to run if you have already uploaded your keystore file to...

You can specify the code signing configuration for your project in Android Studio. You will need a keystore file, a key alias and a key password - have these ready...