BuildType

interface BuildType : Named, VariantDimension, ExtensionAware, HasInitWith

Known direct subclasses
ApplicationBuildType

Build types define certain properties that Gradle uses when building and packaging your app, and are typically configured for different stages of your development lifecycle.

DynamicFeatureBuildType

Build types define certain properties that Gradle uses when building and packaging your app, and are typically configured for different stages of your development lifecycle.

LibraryBuildType

Build types define certain properties that Gradle uses when building and packaging your library, and are typically configured for different stages of your development lifecycle.

TestBuildType

Build types define certain properties that Gradle uses when building and packaging your library, and are typically configured for different stages of your development lifecycle.


Build types define certain properties that Gradle uses when building and packaging your app, and are typically configured for different stages of your development lifecycle.

There are two build types defined by default, debug and release, and you can customize them and create additional build types.

The default debug build type enables debug options and signs the APK with the debug key, while the release build type is not debuggable and can be configured to shrink, obfuscate, and sign your APK with a release key for distribution.

See configuring build types for more information.

Summary

Public functions

Unit

Copies all properties from the given build type.

@Incubating Unit
Unit
setMatchingFallbacks(vararg fallbacks: String)

This function is deprecated. Replaced with property matchingFallbacks

Unit

This function is deprecated. Replaced with property matchingFallbacks

Public properties

Boolean

Specifies code coverage is enabled for module tests of type AndroidTest.

Boolean

Specifies unit test code coverage data collection by configuring the JacocoPlugin.

Boolean

Whether this build type is configured to generate an APK with debuggable native code.

Boolean

Specifies whether to enable code shrinking for this build type.

Boolean

Specifies whether the plugin should generate resources for pseudolocales.

Boolean

Whether the build type is configured to generate an apk with debuggable RenderScript code.

Boolean

Specifies whether to enable shrinking resources for this build type.

Boolean

This property is deprecated. Replaced with: enableUnitTestCoverage and or enableAndroidTestCoverage.

Boolean

This property is deprecated. Changing the value of isZipAlignEnabled no longer has any effect

MutableList<String>

Specifies a sorted list of build types that the plugin should try to use when a direct variant match with a local module dependency is not possible.

PostProcessing
Int

Optimization level to use by the renderscript compiler.

Inherited functions

From class org.gradle.api.plugins.ExtensionAware
From class org.gradle.api.Named
From class com.android.build.api.dsl.VariantDimension
Unit
addManifestPlaceholders(manifestPlaceholders: Map<StringAny>)

Adds manifest placeholders.

Unit
buildConfigField(type: String, name: String, value: String)

Adds a new field to the generated BuildConfig class.

@Incubating Unit

Encapsulates per-variant CMake and ndk-build configurations for your external native build.

Unit

Options for configuring Java compilation.

@Incubating Unit

Encapsulates per-variant configurations for the NDK, such as ABI filters.

@Incubating Unit
Any
proguardFile(proguardFile: Any)

Adds a new ProGuard configuration file.

Any
proguardFiles(vararg files: Any)

Adds new ProGuard configuration files.

Unit
resValue(type: String, name: String, value: String)

Adds a new generated resource.

Void?
setManifestPlaceholders(manifestPlaceholders: Map<StringAny>)

This function is deprecated. Use manifestPlaceholders property instead

Any
setProguardFiles(proguardFileIterable: Iterable<*>)

Replaces the ProGuard configuration files.

@Incubating Unit

Configure the shader compiler options.

Any
testProguardFile(proguardFile: Any)

Adds a proguard rule file to be used when processing test code.

Any
testProguardFiles(vararg proguardFiles: Any)

Adds proguard rule files to be used when processing test code.

Inherited properties

From class com.android.build.api.dsl.VariantDimension
ExternalNativeBuildOptions

Encapsulates per-variant CMake and ndk-build configurations for your external native build.

JavaCompileOptions

Options for configuring Java compilation.

MutableMap<StringAny>

The manifest placeholders.

File?

This property is deprecated. This property is deprecated.

File?

Text file with additional ProGuard rules to be used to determine which classes are compiled into the main dex file.

Ndk

Encapsulates per-variant configurations for the NDK, such as ABI filters.

Optimization
MutableList<File>

Specifies the ProGuard configuration files that the plugin should use.

Shaders

Options for configuring the shader compiler.

MutableList<File>

The collection of proguard rule files to be used when processing test code.

Public functions

initWith

fun initWith(that: BuildType): Unit

Copies all properties from the given build type.

It can be used like this:

android.buildTypes {
customBuildType {
initWith debug
// customize...
}
}

postprocessing

@Incubating
fun postprocessing(action: @ExtensionFunctionType PostProcessing.() -> Unit): Unit

setMatchingFallbacks

fun setMatchingFallbacks(vararg fallbacks: String): Unit

setMatchingFallbacks

fun setMatchingFallbacks(fallbacks: List<String>): Unit

Public properties

enableAndroidTestCoverage

var enableAndroidTestCoverageBoolean

Specifies code coverage is enabled for module tests of type AndroidTest.

If enabled, prepares module class files for code coverage collection such as instrumenting dependent library classes and module classes. This allows for code coverage reports to be generated.

enableUnitTestCoverage

var enableUnitTestCoverageBoolean

Specifies unit test code coverage data collection by configuring the JacocoPlugin.

When enabled, the Jacoco plugin is applied and coverage data is collected by the Jacoco plugin. This can avoid unwanted build time instrumentation required to collect coverage data from other test types such as connected tests.

isJniDebuggable

var isJniDebuggableBoolean

Whether this build type is configured to generate an APK with debuggable native code.

isMinifyEnabled

var isMinifyEnabledBoolean

Specifies whether to enable code shrinking for this build type.

By default, when you enable code shrinking by setting this property to true, the Android plugin uses ProGuard.

To learn more, read Shrink Your Code and Resources.

isPseudoLocalesEnabled

var isPseudoLocalesEnabledBoolean

Specifies whether the plugin should generate resources for pseudolocales.

A pseudolocale is a locale that simulates characteristics of languages that cause UI, layout, and other translation-related problems when an app is localized. Pseudolocales can aid your development workflow because you can test and make adjustments to your UI before you finalize text for translation.

When you set this property to true as shown below, the plugin generates resources for the following pseudo locales and makes them available in your connected device's language preferences: en-XA and ar-XB.

android {
buildTypes {
debug {
pseudoLocalesEnabled true
}
}
}

When you build your app, the plugin includes the pseudolocale resources in your APK. If you notice that your APK does not include those locale resources, make sure your build configuration isn't limiting which locale resources are packaged with your APK, such as using the resourceConfigurations property to remove unused locale resources.

To learn more, read Test Your App with Pseudolocales.

isRenderscriptDebuggable

var isRenderscriptDebuggableBoolean

Whether the build type is configured to generate an apk with debuggable RenderScript code.

RenderScript APIs are deprecated starting in Android 12. For more information about how to migrate, see https://developer.android.com/guide/topics/renderscript/migrate

isShrinkResources

var isShrinkResourcesBoolean

Specifies whether to enable shrinking resources for this build type.

To learn more, read Shrink Your Code and Resources.

isTestCoverageEnabled

var isTestCoverageEnabledBoolean

Whether test coverage is enabled for this build type.

If enabled this uses Jacoco to capture coverage and creates a report in the build directory.

The version of Jacoco can be configured with:

android {
testCoverage {
jacocoVersion = '0.6.2.201302030002'
}
}

isTestCoverageEnabled is deprecated. Use enableUnitTestCoverage and enableAndroidTestCoverage instead which allow you to enable coverage separately for unit and instrumentation tests.

isZipAlignEnabled

var isZipAlignEnabledBoolean

matchingFallbacks

val matchingFallbacksMutableList<String>

Specifies a sorted list of build types that the plugin should try to use when a direct variant match with a local module dependency is not possible.

Android plugin 3.0.0 and higher try to match each variant of your module with the same one from its dependencies. For example, when you build a "freeDebug" version of your app, the plugin tries to match it with "freeDebug" versions of the local library modules the app depends on.

However, there may be situations in which your app includes build types that a dependency does not. For example, consider if your app includes a "stage" build type, but a dependency includes only a "debug" and "release" build type. When the plugin tries to build the "stage" version of your app, it won't know which version of the dependency to use, and you'll see an error message similar to the following:

Error:Failed to resolve: Could not resolve project :mylibrary.
Required by:
project :app

In this situation, you can use matchingFallbacks to specify alternative matches for the app's "stage" build type, as shown below:

// In the app's build.gradle file.
android {
buildTypes {
release {
// Because the dependency already includes a "release" build type,
// you don't need to provide a list of fallbacks here.
}
stage {
// Specifies a sorted list of fallback build types that the
// plugin should try to use when a dependency does not include a
// "stage" build type. You may specify as many fallbacks as you
// like, and the plugin selects the first build type that's
// available in the dependency.
matchingFallbacks = ['debug', 'qa', 'release']
}
}
}

Note that there is no issue when a library dependency includes a build type that your app does not. That's because the plugin simply never requests that build type from the dependency.

Returns
MutableList<String>

the names of product flavors to use, in descending priority order

postprocessing

val postprocessingPostProcessing

renderscriptOptimLevel

var renderscriptOptimLevelInt

Optimization level to use by the renderscript compiler. RenderScript APIs are deprecated starting in Android 12. For more information about how to migrate, see https://developer.android.com/guide/topics/renderscript/migrate