android/gradle-recipes

Ready-to-use recipes for common build customizations that showcase the Android Gradle plugin's public APIs and DSL.

Recipes for AGP version 8.4

This branch contains recipes compatible with AGP 8.4. If you want to find recipes for other AGP versions, switch to the corresponding agp-* branch.

This branch is read only. Contributions are only accepted on the studio-main branch. See CONTRIBUTION.md there.

Recipes Index

Index is organized in categories, offering different ways to reach the recipe you want.

Themes

• Android Assets - legacyTaskBridging, addCustomAsset
• Android Manifest - transformManifest, perVariantManifestPlaceholder, createSingleArtifact
• Artifact API - getScopedArtifacts, transformManifest, transformDirectory, transformMultiple, appendToMultipleArtifact, listenToArtifacts, getMultipleArtifact, workerEnabledTransformation, getSingleArtifact, transformAllClasses, createSingleArtifact, addMultipleArtifact
• DSL - addBuildTypeUsingDslFinalize, extendingAgp
• Dependency Resolution - variantDependencySubstitutionTest
• Sources - addCustomSourceFolders, legacyTaskBridging, addCustomAsset

Plugin Features

• TestFixtures - testFixtures

APIs

• AndroidComponentsExtension.beforeVariants() - selectVariants
• AndroidComponentsExtension.onVariants() - getScopedArtifacts, variantOutput, addCustomSourceFolders, transformManifest, transformDirectory, allProjectsApkAction, transformMultiple, appendToMultipleArtifact, addCustomBuildConfigFields, onVariants, listenToArtifacts, getMultipleArtifact, workerEnabledTransformation, getSingleArtifact, perVariantManifestPlaceholder, variantDependencySubstitutionTest, transformAllClasses, createSingleArtifact, legacyTaskBridging, registerPreBuild, asmTransformClasses, addMultipleArtifact, extendingAgp, addCustomAsset
• AndroidComponentsExtension.registerExtension() - extendingAgp
• AndroidComponentsExtension.selector() - variantOutput, allProjectsApkAction, selectVariants
• ApplicationVariant.applicationId - onVariants
• ApplicationVariant.outputs - variantOutput
• Artifact.ContainsMany - listenToArtifacts
• ArtifactTransformationRequest - workerEnabledTransformation
• Artifacts.add() - transformMultiple, addMultipleArtifact
• Artifacts.forScope() - getScopedArtifacts, transformAllClasses
• Artifacts.get() - variantOutput, transformManifest, transformDirectory, allProjectsApkAction, transformMultiple, appendToMultipleArtifact, getSingleArtifact, perVariantManifestPlaceholder, legacyTaskBridging, addMultipleArtifact, addCustomAsset
• Artifacts.getAll() - getMultipleArtifact
• Artifacts.use() - transformManifest, transformDirectory, transformMultiple, appendToMultipleArtifact, listenToArtifacts, workerEnabledTransformation, createSingleArtifact
• BuildConfigField() - addCustomBuildConfigFields
• BuiltArtifact - workerEnabledTransformation
• BuiltArtifact.versionCode - listenToArtifacts
• BuiltArtifact.versionName - listenToArtifacts
• BuiltArtifacts.elements - listenToArtifacts
• BuiltArtifacts.variantName - listenToArtifacts
• BuiltArtifactsLoader.load() - listenToArtifacts
• CanMinifyAndroidResourcesBuilder.shrinkResources - selectVariants
• CanMinifyCodeBuilder.isMinifyEnabled - selectVariants
• CombiningOperationRequest.toTransform() - transformMultiple
• Component.artifacts - getScopedArtifacts, variantOutput, transformManifest, transformDirectory, transformMultiple, appendToMultipleArtifact, getMultipleArtifact, createSingleArtifact, legacyTaskBridging, addMultipleArtifact, addCustomAsset
• Component.compileConfiguration - variantDependencySubstitutionTest
• Component.runtimeConfiguration - variantDependencySubstitutionTest
• Component.sources - addCustomSourceFolders, legacyTaskBridging, addCustomAsset
• Configuration.resolutionStrategy - variantDependencySubstitutionTest
• DslExtension.Builder.build() - extendingAgp
• DslExtension.Builder.extendBuildTypeWith() - extendingAgp
• DslExtension.Builder.extendProductFlavorWith() - extendingAgp
• DslExtension.Builder.extendProjectWith() - extendingAgp
• DslLifecycle.finalizeDsl() - addBuildTypeUsingDslFinalize
• GeneratesApk.applicationId - onVariants
• Gradle.beforeProject() - allProjectsApkAction
• HasUnitTestBuilder.enableUnitTest - selectVariants
• InAndOutDirectoryOperationRequest.toTransform() - transformDirectory
• InAndOutDirectoryOperationRequest.toTransformMany() - workerEnabledTransformation
• InAndOutFileOperationRequest.toTransform() - transformManifest
• Instrumentation.transformClassesWith() - asmTransformClasses
• LifeCycleTasks.registerPreBuild() - registerPreBuild
• MapProperty.put() - addCustomBuildConfigFields, perVariantManifestPlaceholder
• MultipleArtifact.MULTIDEX_KEEP_PROGUARD - getMultipleArtifact
• MultipleArtifact.NATIVE_DEBUG_METADATA - transformMultiple, appendToMultipleArtifact, addMultipleArtifact
• OutOperationRequest.toAppendTo() - appendToMultipleArtifact
• OutOperationRequest.toCreate() - createSingleArtifact
• OutOperationRequest.toListenTo() - listenToArtifacts
• Plugin - allProjectsApkAction
• ResolutionStrategy.dependencySubstitution() - variantDependencySubstitutionTest
• ScopedArtifact.CLASSES - getScopedArtifacts, transformAllClasses, asmTransformClasses
• ScopedArtifacts.Scope.ALL - getScopedArtifacts
• ScopedArtifacts.Scope.PROJECT - getScopedArtifacts, transformAllClasses, asmTransformClasses
• ScopedArtifacts.use() - getScopedArtifacts, transformAllClasses, asmTransformClasses
• ScopedArtifactsOperation.toGet() - getScopedArtifacts, asmTransformClasses
• ScopedArtifactsOperation.toTransform() - transformAllClasses
• SingleArtifact.APK - allProjectsApkAction, listenToArtifacts, workerEnabledTransformation
• SingleArtifact.ASSETS - transformDirectory, legacyTaskBridging, addCustomAsset
• SingleArtifact.BUNDLE - appendToMultipleArtifact, getSingleArtifact, addMultipleArtifact
• SingleArtifact.MERGED_MANIFEST - variantOutput, transformManifest, perVariantManifestPlaceholder, createSingleArtifact
• SourceDirectories.addGeneratedSourceDirectory() - addCustomSourceFolders, legacyTaskBridging, addCustomAsset
• SourceDirectories.addStaticSourceDirectory() - addCustomSourceFolders
• TaskBasedOperation.wiredWith() - transformMultiple, listenToArtifacts, createSingleArtifact
• TaskBasedOperation.wiredWithDirectories() - transformDirectory, workerEnabledTransformation
• TaskBasedOperation.wiredWithFiles() - transformManifest
• TaskOutputs.upToDateWhen() - transformManifest
• TaskProvider.flatMap() - createSingleArtifact
• TaskProvider.map() - addCustomBuildConfigFields
• Variant.buildConfigFields - addCustomBuildConfigFields
• Variant.components - variantDependencySubstitutionTest
• Variant.manifestPlaceholders - perVariantManifestPlaceholder
• Variant.nestedComponents - variantDependencySubstitutionTest
• VariantBuilder.minSdk - selectVariants
• VariantExtensionConfig - extendingAgp
• VariantOutputConfiguration.OutputType.SINGLE - variantOutput
• VariantOutputConfiguration.outputType - variantOutput
• VariantSelector.all() - variantOutput, selectVariants
• VariantSelector.withBuildType() - allProjectsApkAction, selectVariants, variantDependencySubstitutionTest
• VariantSelector.withFlavor() - variantOutput, selectVariants
• VariantSelector.withName() - selectVariants
• task.getOutputs() - transformManifest

Call chains

• DslExtension.Builder().extendProjectWith().extendBuildTypeWith().extendProductFlavorWith().build() - extendingAgp
• androidComponents.beforeVariants {} - selectVariants
• androidComponents.finalizeDsl {} - addBuildTypeUsingDslFinalize
• androidComponents.onVariants {} - getScopedArtifacts, variantOutput, addCustomSourceFolders, transformManifest, transformDirectory, allProjectsApkAction, transformMultiple, appendToMultipleArtifact, addCustomBuildConfigFields, onVariants, listenToArtifacts, getMultipleArtifact, workerEnabledTransformation, getSingleArtifact, perVariantManifestPlaceholder, variantDependencySubstitutionTest, transformAllClasses, createSingleArtifact, legacyTaskBridging, registerPreBuild, asmTransformClasses, addMultipleArtifact, extendingAgp, addCustomAsset
• androidComponents.registerExtension() - extendingAgp
• androidComponents.selector().all() - variantOutput, selectVariants
• androidComponents.selector().withBuildType() - allProjectsApkAction, selectVariants, variantDependencySubstitutionTest
• androidComponents.selector().withFlavor() - variantOutput, selectVariants
• androidComponents.selector().withName() - selectVariants
• configuration.resolutionStrategy.dependencySubstitution {} - variantDependencySubstitutionTest
• settings.gradle.beforeProject {} - allProjectsApkAction
• substitute().using() - variantDependencySubstitutionTest
• task.outputs.upToDateWhen {} - transformManifest
• transformationRequest.submit() - workerEnabledTransformation
• variant.applicationId - onVariants
• variant.artifacts.add() - transformMultiple, addMultipleArtifact
• variant.artifacts.forScope().use().toGet() - getScopedArtifacts, asmTransformClasses
• variant.artifacts.forScope().use().toTransform() - transformAllClasses
• variant.artifacts.get() - variantOutput, transformManifest, transformDirectory, allProjectsApkAction, transformMultiple, appendToMultipleArtifact, getSingleArtifact, perVariantManifestPlaceholder, legacyTaskBridging, asmTransformClasses, addMultipleArtifact, addCustomAsset
• variant.artifacts.getAll() - getMultipleArtifact
• variant.artifacts.use().wiredWith().toAppendTo() - appendToMultipleArtifact
• variant.artifacts.use().wiredWith().toCreate() - createSingleArtifact
• variant.artifacts.use().wiredWith().toListenTo() - listenToArtifacts
• variant.artifacts.use().wiredWith().toTransform() - transformMultiple
• variant.artifacts.use().wiredWithDirectories().toTransform() - transformDirectory
• variant.artifacts.use().wiredWithDirectories().toTransformMany() - workerEnabledTransformation
• variant.artifacts.use().wiredWithFiles().toTransform() - transformManifest
• variant.buildConfigFields.put() - addCustomBuildConfigFields
• variant.instrumentation.transformClassesWith() - asmTransformClasses
• variant.manifestPlaceholders.put() - perVariantManifestPlaceholder
• variant.registerPreBuild() - registerPreBuild
• variant.sources.*.addGeneratedSourceDirectory() - addCustomSourceFolders, legacyTaskBridging, addCustomAsset
• variant.sources.*.addStaticSourceDirectory() - addCustomSourceFolders

Others

• All projects - allProjectsApkAction
• Extending AGP DSL - extendingAgp
• Legacy API bridging - legacyTaskBridging
• Placeholders - perVariantManifestPlaceholder
• Renaming APKs - listenToArtifacts
• SourceDirectories.add - addCustomSourceFolders
• registerSourceType - addCustomSourceFolders

License

Copyright 2022 The Android Open Source Project

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.