BuildType

interface BuildType : VariantDimension, 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

@Incubating Unit

Copies all properties from the given build type.

@Incubating Unit
@Incubating Unit
setMatchingFallbacks(vararg fallbacks: String?)

This function is deprecated. Replaced with property matchingFallbacks

@Incubating Unit

This function is deprecated. Replaced with property matchingFallbacks

Public properties

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

Whether test coverage is enabled for this build type.

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 ExtensionAware
From class Named
From class VariantDimension
@Incubating Unit
addManifestPlaceholders(manifestPlaceholders: Map<String?, Any?>?)

Adds manifest placeholders.

@Incubating 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
ndk(action: (@ExtensionFunctionType Ndk.() -> Unit)?)

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

@Incubating Any
proguardFile(proguardFile: Any?)

Adds a new ProGuard configuration file.

@Incubating Any
proguardFiles(vararg files: Any?)

Adds new ProGuard configuration files.

@Incubating Unit
resValue(type: String?, name: String?, value: String?)

Adds a new generated resource.

@Incubating Void?
setManifestPlaceholders(manifestPlaceholders: Map<String?, Any?>?)

This function is deprecated. Use manifestPlaceholders property instead

@Incubating Any
setProguardFiles(proguardFileIterable: Iterable<*>?)

Replaces the ProGuard configuration files.

@Incubating Unit

Configure the shader compiler options.

@Incubating Any
testProguardFile(proguardFile: Any?)

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

@Incubating Any
testProguardFiles(vararg proguardFiles: Any?)

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

Public functions

initWith

@Incubating
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

@Incubating
fun setMatchingFallbacks(vararg fallbacks: String?): Unit

setMatchingFallbacks

@Incubating
fun setMatchingFallbacks(fallbacks: List<String?>?): Unit

Public properties

enableUnitTestCoverage

val 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

val isJniDebuggableBoolean

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

isMinifyEnabled

val 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

val 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

val isRenderscriptDebuggableBoolean

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

isShrinkResources

val isShrinkResourcesBoolean

Specifies whether to enable shrinking resources for this build type.

To learn more, read Shrink Your Code and Resources.

isTestCoverageEnabled

val 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'
}
}

isZipAlignEnabled

val 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

val renderscriptOptimLevelInt

Optimization level to use by the renderscript compiler.