agp-9-upgrade by android/skills

Migration guide

See the AGP 9 migration guide for the major changes, many breaking, in AGP 9 compared to AGP 8.

Requirements

If the user requests to update or migrate to AGP 9, first check the AGP version used in the project. If it is lower than 9, stop and ask the user to run the AGP Upgrade Assistant in Android Studio, and confirm when done.

Each version of AGP has its own set of compatibilities with other tools, such as Gradle, JDK, and Kotlin. The release notes for each of these versions will include a Compatibility table indicating the minimum versions for these tools.

Steps

If AGP is already at 9 or higher, then do the following:

Step 1: Migrate to built-in Kotlin.

See the guide for detailed information.

Step 2. Migrate to the new AGP DSL.

See the guide for detailed information.

See also gradle-recipes for examples on how to migrate old code to code that is compatible with AGP 9 and the new DSL.

Step 3. Migrate kapt to KSP or legacy-kapt

If KSP (com.google.devtools.ksp) is used in the project, ensure it is on version 2.3.6 or higher.

See KSP, kapt, and legacy-kapt for detailed information.

Step 4. BuildConfig

If any Android module contains custom BuildConfig fields, see BuildConfig for detailed information.

Step 5. Update gradle.properties

After the migration, check gradle.properties. Remove the following flags:

android.builtInKotlin
android.newDsl
android.uniquePackageNames
android.enableAppCompileTimeRClass

Additionally, delete all temporary files you've created.

Guidelines

Never write or run python scripts.
Only search the Gradle dependency cache when inspecting external dependencies, and only as a last resort.
Never add android.disallowKotlinSourceSets=false to gradle.properties.
When verifying changes, don't run the clean task. This is a waste of time.

Verification

After migration, verify the following:

Gradle IDE sync succeeds.
./gradlew help succeeds.
./gradlew build --dry-run succeeds.

Troubleshooting

Paparazzi v2.0.0-alpha04 and lower versions have issues with AGP 9. See references/paparazzi-gradle-9.md for details.