upgradepluginversion.md

Update a Gradle plugin by id

org.openrewrite.gradle.plugins.UpgradePluginVersion

Update a Gradle plugin by id to a later version.

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite
• artifactId: rewrite-gradle
• version: 8.1.3

Options

Type	Name	Description
String	pluginIdPattern	The ID part of plugin { ID }, as a glob expression.
String	newVersion	An exact version number or node-style semver selector used to select the version number.
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

Data Tables (Only available on the Moderne platform)

Maven metadata failures

Attempts to resolve maven metadata that failed.

Column Name	Description

Example

Parameters

Parameter	Value
pluginIdPattern	org.openrewrite.rewrite
newVersion	latest.patch
versionPattern	null

{% tabs %} {% tab title="build.gradle" %}

Before

{% code title="build.gradle" %}

plugins {
    id 'org.openrewrite.rewrite' version '5.40.0'
    id 'com.github.johnrengelman.shadow' version '6.1.0'
}

{% endcode %}

After

{% code title="build.gradle" %}

plugins {
    id 'org.openrewrite.rewrite' version '5.40.6'
    id 'com.github.johnrengelman.shadow' version '6.1.0'
}

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- build.gradle
+++ build.gradle
@@ -2,1 +2,1 @@
plugins {
-   id 'org.openrewrite.rewrite' version '5.40.0'
+   id 'org.openrewrite.rewrite' version '5.40.6'
    id 'com.github.johnrengelman.shadow' version '6.1.0'

{% endcode %} {% endtab %} {% endtabs %}

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.UpgradePluginVersionExample. Here's how you can define and customize such a recipe within your rewrite.yml:

{% code title="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'

{% endcode %}

Now that com.yourorg.UpgradePluginVersionExample has been defined activate it in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

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

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %}

{% endtabs %}

Contributors

• Jonathan Schneider
• Shannon Pamperl
• Sam Snyder
• Jonathan Leitschuh

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.