Comment on page

Add Gradle settings plugin

org.openrewrite.gradle.plugins.AddSettingsPlugin
Add plugin to Gradle settings file plugins block by id.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-gradle
version: 8.9.5
Options
Type
Name
Description
String
pluginId
The plugin id to apply.
String
version
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. Defaults to latest.release.
String
versionPattern
Optional. 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
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.AddSettingsPluginExample. 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.AddSettingsPluginExample
displayName: Add Gradle settings plugin example
recipeList:
  - org.openrewrite.gradle.plugins.AddSettingsPlugin:
      pluginId: com.jfrog.bintray
      version: 3.x
      versionPattern: '-jre'
Now that com.yourorg.AddSettingsPluginExample 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.AddSettingsPluginExample")
}
​
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 AddSettingsPlugin
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, Sam Snyder, Jonathan Schnéider​

Type	Name	Description
`String`	pluginId	The plugin id to apply.
`String`	version	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. Defaults to `latest.release`.
`String`	versionPattern	Optional. 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

Add Gradle plugin

Add a Gradle settings repository

Last modified 10d ago