upgradedependencyversion.md

Upgrade Gradle dependency versions

org.openrewrite.gradle.UpgradeDependencyVersion

_Upgrade the version of a dependency in a build.gradle file. Supports updating dependency declarations of various forms:

• String notation: "group:artifact:version"
• Map notation: group: 'group', name: 'artifact', version: 'version' Can update version numbers which are defined earlier in the same file in variable declarations._

Source

GitHub, Issue Tracker, Maven Central

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

Options

Type	Name	Description
String	groupId	The first part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression.
String	artifactId	The second part of a dependency coordinate com.google.guava:guava:VERSION. This can be 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
groupId	com.google.guava
artifactId	guava
newVersion	30.x
versionPattern	-jre

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

Before

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

plugins {
  id 'java-library'
}

repositories {
  mavenCentral()
}

dependencies {
  compileOnly 'com.google.guava:guava:29.0-jre'
  runtimeOnly ('com.google.guava:guava:29.0-jre') {
      force = true
  }
}

{% endcode %}

After

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

plugins {
  id 'java-library'
}

repositories {
  mavenCentral()
}

dependencies {
  compileOnly 'com.google.guava:guava:30.1.1-jre'
  runtimeOnly ('com.google.guava:guava:30.1.1-jre') {
      force = true
  }
}

{% endcode %}

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

--- build.gradle
+++ build.gradle
@@ -10,2 +10,2 @@

dependencies {
- compileOnly 'com.google.guava:guava:29.0-jre'
- runtimeOnly ('com.google.guava:guava:29.0-jre') {
+ compileOnly 'com.google.guava:guava:30.1.1-jre'
+ runtimeOnly ('com.google.guava:guava:30.1.1-jre') {
      force = true

{% 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.UpgradeDependencyVersionExample. 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.UpgradeDependencyVersionExample
displayName: Upgrade Gradle dependency versions example
recipeList:
  - org.openrewrite.gradle.UpgradeDependencyVersion:
      groupId: com.fasterxml.jackson*
      artifactId: jackson-module*
      newVersion: 29.X
      versionPattern: '-jre'

{% endcode %}

Now that com.yourorg.UpgradeDependencyVersionExample 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.UpgradeDependencyVersionExample")
}

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %}

{% endtabs %}

Contributors

• Sam Snyder
• Shannon Pamperl
• Geoffrey De Smet
• Jonathan Schnéider

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.