Build variants (debug, release) in Android Kotlin

Introduction

Build variants let you create different versions of your app easily. For example, one for testing (debug) and one for users (release).

When you want to test your app with extra tools before sharing it.

When you need a version of your app without debug info for app stores.

When you want to add special features only for testing.

When you want to keep your app secure by hiding keys in release builds.

When you want to speed up the app by removing debug code in release.

Syntax

Android Kotlin

android {
    buildTypes {
        debug {
            applicationIdSuffix ".debug"
            versionNameSuffix "-DEBUG"
            debuggable true
        }
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.release
        }
    }
}

The debug build type is for testing and usually includes extra info.

The release build type is optimized and signed for publishing.

Examples

This example adds ".debug" to the app ID for debug builds and disables code shrinking in release.

Android Kotlin

buildTypes {
    debug {
        applicationIdSuffix ".debug"
        debuggable true
    }
    release {
        minifyEnabled false
    }
}

This example adds "-dev" to the version name in debug and sets signing for release.

Android Kotlin

buildTypes {
    debug {
        versionNameSuffix "-dev"
    }
    release {
        signingConfig signingConfigs.release
    }
}

Sample App

This Gradle script defines two build variants: debug and release. Debug adds ".debug" to the app ID and "-DEBUG" to the version name, making it easy to identify. Release enables code shrinking and uses signing for publishing.

Android Kotlin

android {
    compileSdk 33
    defaultConfig {
        applicationId "com.example.myapp"
        minSdk 21
        targetSdk 33
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        debug {
            applicationIdSuffix ".debug"
            versionNameSuffix "-DEBUG"
            debuggable true
        }
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.release
        }
    }
}

Important Notes

Always test your release build before publishing to catch issues.

Debug builds are slower but easier to fix problems in.

You can create more build variants for flavors like free or paid versions.

Summary

Build variants let you make different app versions from one project.

Debug is for testing; release is for publishing.

You control settings like app ID, version, and optimization per variant.

Practice

1. What is the main purpose of the debug build variant in Android development?

easy

A. To publish the app on the Play Store

B. To test the app with debugging tools enabled

C. To reduce the app size for faster downloads

D. To disable all logging and debugging features

Solution

1. Step 1: Understand build variant roles

   The debug variant is designed for developers to test and debug the app during development.

2. Step 2: Compare with release variant

   The release variant is optimized and signed for publishing, unlike debug.

3. Final Answer:

   To test the app with debugging tools enabled -> Option B

4. Quick Check:

   Debug variant = testing with debugging [OK]

Hint: Debug variant is for testing, release is for publishing [OK]

Common Mistakes:

• Confusing debug with release variant
• Thinking debug is for publishing
• Assuming debug disables logging

2. Which of the following is the correct way to specify a release build variant in the build.gradle file?

easy

A. buildVariants { debug { minifyEnabled false } }

B. buildVariants { release { minifyEnabled true } }

C. buildTypes { release { minifyEnabled false } }

D. buildTypes { debug { minifyEnabled true } }

Solution

1. Step 1: Identify correct block name

   The correct block to define build variants is buildTypes, not buildVariants.

2. Step 2: Check release variant syntax

   Inside buildTypes, release can have minifyEnabled set to true or false. buildTypes { release { minifyEnabled false } } uses correct syntax with minifyEnabled false.

3. Final Answer:

   buildTypes { release { minifyEnabled false } } -> Option C

4. Quick Check:

   Use buildTypes block for release variant [OK]

Hint: Use buildTypes, not buildVariants, to define release [OK]

Common Mistakes:

• Using buildVariants instead of buildTypes
• Mixing debug and release settings
• Incorrect minifyEnabled value placement

3. Given this build.gradle snippet, what will be the application ID for the debug build variant?

android {
  defaultConfig {
    applicationId "com.example.app"
  }
  buildTypes {
    debug {
      applicationIdSuffix ".debug"
    }
    release {
      minifyEnabled true
    }
  }
}

medium

A. com.example.app

B. com.example.debug.app

C. com.example.apprelease

D. com.example.app.debug

Solution

1. Step 1: Identify default application ID

   The default application ID is com.example.app from defaultConfig.

2. Step 2: Check debug variant suffix

   The debug build type adds .debug as a suffix to the application ID.

3. Final Answer:

   com.example.app.debug -> Option D

4. Quick Check:

   Debug variant adds suffix .debug [OK]

Hint: Debug adds suffix; release usually does not [OK]

Common Mistakes:

• Ignoring applicationIdSuffix
• Confusing suffix placement
• Assuming release suffix applies to debug

4. You have this build.gradle snippet:

buildTypes {
  release {
    minifyEnabled true
    proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
  }
  debug {
    minifyEnabled true
  }
}

What is the problem with this configuration?

medium

A. minifyEnabled should be false for debug builds to avoid obfuscation

B. proguardFiles cannot be used in release builds

C. minifyEnabled must be true for debug builds

D. The buildTypes block is missing a closing brace

Solution

1. Step 1: Understand minifyEnabled purpose

   Minify (obfuscation) is usually enabled in release builds to shrink and protect code.

2. Step 2: Check debug build settings

   Enabling minify in debug builds is uncommon and can make debugging harder.

3. Final Answer:

   minifyEnabled should be false for debug builds to avoid obfuscation -> Option A

4. Quick Check:

   Debug builds usually disable minify [OK]

Hint: Disable minify in debug to ease debugging [OK]

Common Mistakes:

• Enabling minify in debug builds
• Thinking proguardFiles are invalid in release
• Missing braces in buildTypes block

5. You want to create a new build variant called staging that behaves like release but with a different application ID and no code shrinking. Which build.gradle snippet correctly achieves this?

hard

A. buildTypes {
staging {
initWith release
applicationIdSuffix ".staging"
minifyEnabled false
}
}

B. buildTypes {
staging {
initWith debug
applicationIdSuffix ".staging"
minifyEnabled true
}
}

C. buildTypes {
staging {
applicationIdSuffix ".staging"
minifyEnabled true
}
}

D. buildTypes {
staging {
initWith release
applicationIdSuffix ".release"
minifyEnabled true
}
}

Solution

1. Step 1: Use initWith to copy release settings

   The initWith release copies all release build settings to staging.

2. Step 2: Override applicationIdSuffix and minifyEnabled

   Set applicationIdSuffix ".staging" to differentiate the app ID and minifyEnabled false to disable code shrinking.

3. Final Answer:

   buildTypes { staging { initWith release applicationIdSuffix ".staging" minifyEnabled false } } -> Option A

4. Quick Check:

   initWith release + override suffix and minify [OK]

Hint: Use initWith release, then override needed settings [OK]

Common Mistakes:

• Using initWith debug instead of release
• Forgetting to disable minify for staging
• Using wrong applicationIdSuffix