Skip to main content

Update a Gradle plugin by id

org.openrewrite.gradle.plugins.UpgradePluginVersion

Update a Gradle plugin by id to a later version.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringpluginIdPatternThe ID part of plugin { ID }, as a glob expression.com.jfrog.bintray
StringnewVersionOptional. An exact version number or node-style semver selector used to select the version number. You can also use latest.release for the latest available version and latest.patch if the current version is a valid semantic version. For more details, you can look at the documentation page of version selectors. Defaults to latest.release.29.X
StringversionPatternOptional. Allows version selection to be extended beyond the original Node Semver semantics. So for example,Setting 'version' to "25-29" can be paired with a metadata pattern of "-jre" to select Guava 29.0-jre-jre

Examples​

Example 1​

Upgrading a build plugin

Parameters​
ParameterValue
pluginIdPatternorg.openrewrite.rewrite
newVersionlatest.patch
versionPatternnull
Before​
build.gradle
plugins {
    id 'org.openrewrite.rewrite' version '5.40.0'
    id 'com.github.johnrengelman.shadow' version '6.1.0'
}
After​
build.gradle
plugins {
    id 'org.openrewrite.rewrite' version '5.40.6'
    id 'com.github.johnrengelman.shadow' version '6.1.0'
}
Example 2​

Upgrading a settings plugin

Parameters​
ParameterValue
pluginIdPatterncom.gradle.enterprise
newVersion3.10.x
versionPatternnull
Before​
plugins {
    id 'com.gradle.enterprise' version '3.10'
}
After​
plugins {
    id 'com.gradle.enterprise' version '3.10.3'
}
Example 3​

Upgrading a build plugin with version in gradle.properties

Parameters​
ParameterValue
pluginIdPatternorg.openrewrite.rewrite
newVersion5.40.x
versionPatternnull
Unchanged​
build.gradle
plugins {
    id 'org.openrewrite.rewrite' version "$rewriteVersion"
    id 'com.github.johnrengelman.shadow' version '6.1.0'
}
Before​
rewriteVersion=5.40.0
After​
rewriteVersion=5.40.6

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.UpgradePluginVersionExample. 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.UpgradePluginVersionExample
displayName: Update a Gradle plugin by id example
recipeList:
  - org.openrewrite.gradle.plugins.UpgradePluginVersion:
      pluginIdPattern: com.jfrog.bintray
      newVersion: 29.X
      versionPattern: '-jre'

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

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.6.1")
}

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

repositories {
    mavenCentral()
}
  1. 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​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.