Comment on page

Change a Gradle plugin

org.openrewrite.gradle.plugins.ChangePlugin
Changes the selected Gradle plugin to the new plugin.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-gradle
version: 8.9.5
Options
Type
Name
Description
String
pluginId
The current Gradle plugin id.
String
newPluginId
The new Gradle plugin id.
String
newVersion
Optional. 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.
Usage
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. 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.ChangePluginExample. 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.ChangePluginExample
displayName: Change a Gradle plugin example
recipeList:
  - org.openrewrite.gradle.plugins.ChangePlugin:
      pluginId: org.openrewrite.rewrite
      newPluginId: org.openrewrite.rewrite
      newVersion: 7.x
Now that com.yourorg.ChangePluginExample has been defined activate it in your build file:
Gradle
Moderne CLI
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.5.6")
}
​
rewrite {
    activeRecipe("com.yourorg.ChangePluginExample")
}
​
repositories {
    mavenCentral()
}
2.Run gradle rewriteRun to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe ChangePlugin
See how this recipe works across multiple open-source repositories
​​
​​
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.
Contributors
​Shannon Pamperl​

Type	Name	Description
`String`	pluginId	The current Gradle plugin id.
`String`	newPluginId	The new Gradle plugin id.
`String`	newVersion	Optional. 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.

Add the Develocity Gradle plugin

Remove Gradle plugin

Last modified 9d ago