Skip to main content

Upgrade Android Gradle Plugin version

org.openrewrite.android.UpgradeAndroidGradlePluginVersion

Upgrade the Android Gradle Plugin (AGP) version. Handles both the legacy buildscript { dependencies { classpath 'com.android.tools.build:gradle:...' } } form (delegating to the upstream UpgradeDependencyVersion recipe for full DSL coverage) and the modern plugins { id("com.android.application") version "..." } form.

Recipe source​

GitHub: UpgradeAndroidGradlePluginVersion.java, Issue Tracker, Code Genome Project

This recipe is available under the Moderne Source Available License. Moderne customers can download precompiled artifacts from The Code Genome Project. For non-commercial use you can build the artifact from source locally.

Options​

TypeNameDescriptionExample
StringnewVersionAn exact version number or node-style semver selector used to select the version number.8.5.0
StringversionPatternOptional. Allows version selection to be extended beyond the original Node Semver semantics.8.5.0

Definition​

Used by​

This recipe is used as part of the following composite recipes:

Example​

Parameters​
ParameterValue
newVersion8.5.0
versionPatternnull
Before​
build.gradle
plugins {
    id 'com.android.application' version '8.0.0'
}
After​
build.gradle
plugins {
    id 'com.android.application' version '8.5.0'
}

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.UpgradeAndroidGradlePluginVersionExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.UpgradeAndroidGradlePluginVersionExample
displayName: Upgrade Android Gradle Plugin version example
recipeList:
  - org.openrewrite.android.UpgradeAndroidGradlePluginVersion:
      newVersion: 8.5.0
      versionPattern: 8.5.0

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies.

Now that com.yourorg.UpgradeAndroidGradlePluginVersionExample has been defined, activate it in your build file:

OpenRewrite artifacts, including the Maven and Gradle plugins themselves, are distributed through the Code Genome Project repository (https://artifacts.codegenomeproject.org/maven), which requires authentication. Sign in to the Code Genome Project to create a download token; your build authenticates with the email or username you signed in with, plus that token as the password. See the quickstart guide for details.

  1. Put your Code Genome Project credentials in ~/.gradle/gradle.properties, so that they are not committed alongside your build:
    ~/.gradle/gradle.properties
    codegenomeUsername=you@example.com
    codegenomePassword=your-download-token
  2. Add the Code Genome Project repository to your settings.gradle file, so that the plugin itself can be resolved:
    settings.gradle
    pluginManagement {
        repositories {
            maven {
                url = "https://artifacts.codegenomeproject.org/maven"
                credentials {
                    username = providers.gradleProperty("codegenomeUsername").get()
                    password = providers.gradleProperty("codegenomePassword").get()
                }
            }
            // Keep the portal for any other plugins your build applies
            gradlePluginPortal()
        }
    }
  3. Add the following to your build.gradle file:
    build.gradle
    plugins {
        id("org.openrewrite.rewrite") version("latest.release")
    }

    rewrite {
        activeRecipe("com.yourorg.UpgradeAndroidGradlePluginVersionExample")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
        maven {
            url = "https://artifacts.codegenomeproject.org/maven"
            credentials {
                username = providers.gradleProperty("codegenomeUsername").get()
                password = providers.gradleProperty("codegenomePassword").get()
            }
        }
    }
  4. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Maven metadata failures​

org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Column NameDescription
Group idThe groupId of the artifact for which the metadata download failed.
Artifact idThe artifactId of the artifact for which the metadata download failed.
VersionThe version of the artifact for which the metadata download failed.
Maven repositoryThe URL of the Maven repository that the metadata download failed on.
SnapshotsDoes the repository support snapshots.
ReleasesDoes the repository support releases.
FailureThe reason the metadata download failed.