Change Gradle dependency

org.openrewrite.gradle.ChangeDependency

Change a Gradle dependency coordinates. The newGroupId or newArtifactId MUST be different from before.

Recipe source

GitHub, Issue Tracker, Maven Central

groupId: org.openrewrite
artifactId: rewrite-gradle
version: 8.30.0

Options

Type Name Description Example

Type	Name	Description	Example
`String`	oldGroupId	The old groupId to replace. The groupId is the first part of a dependency coordinate 'com.google.guava:guava:VERSION'. Supports glob expressions.	`org.openrewrite.recipe`
`String`	oldArtifactId	The old artifactId to replace. The artifactId is the second part of a dependency coordinate 'com.google.guava:guava:VERSION'. Supports glob expressions.	`rewrite-testing-frameworks`
`String`	newGroupId	Optional. The new groupId to use. Defaults to the existing group id.	`corp.internal.openrewrite.recipe`
`String`	newArtifactId	Optional. The new artifactId to use. Defaults to the existing artifact id.	`rewrite-testing-frameworks`
`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.	`29.X`
`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	`-jre`
`Boolean`	overrideManagedVersion	Optional. If the old dependency has a managed version, this flag can be used to explicitly set the version on the new dependency. WARNING: No check is done on the NEW dependency to verify if it is managed, it relies on whether the OLD dependency had a managed version. The default for this flag is `false`.

String

oldGroupId

The old groupId to replace. The groupId is the first part of a dependency coordinate 'com.google.guava:guava:VERSION'. Supports glob expressions.

org.openrewrite.recipe

String

oldArtifactId

The old artifactId to replace. The artifactId is the second part of a dependency coordinate 'com.google.guava:guava:VERSION'. Supports glob expressions.

rewrite-testing-frameworks

String

newGroupId

Optional. The new groupId to use. Defaults to the existing group id.

corp.internal.openrewrite.recipe

String

newArtifactId

Optional. The new artifactId to use. Defaults to the existing artifact id.

rewrite-testing-frameworks

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.

29.X

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

-jre

Boolean

overrideManagedVersion

Optional. If the old dependency has a managed version, this flag can be used to explicitly set the version on the new dependency. WARNING: No check is done on the NEW dependency to verify if it is managed, it relies on whether the OLD dependency had a managed version. The default for this flag is false.

Data Tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column Name	Description
Source path before the run	The source path of the file before the run.
Source path after the run	A recipe may modify the source path. This is the path after the run.
Parent of the recipe that made changes	In 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 changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Column Name

Description

Source path before the run

The source path of the file before the run.

Source path after the run

A recipe may modify the source path. This is the path after the run.

Parent of the recipe that made changes

In 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 changes

The specific recipe that made a change.

Estimated time saving

An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.

Cycle

The recipe cycle in which the change was made.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column Name	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Column Name

Description

Source path

The file that failed to parse.

Recipe that made changes

The specific recipe that made a change.

Stack trace

The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column Name	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time	The total time spent across the scanning phase of this recipe.
99th percentile scanning time	99 out of 100 scans completed in this amount of time.
Max scanning time	The max time scanning any one source file.
Cumulative edit time	The total time spent across the editing phase of this recipe.
99th percentile edit time	99 out of 100 edits completed in this amount of time.
Max edit time	The max time editing any one source file.

Column Name

Description

The recipe

The recipe whose stats are being measured both individually and cumulatively.

Source file count

The number of source files the recipe ran over.

Source file changed count

The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.

Cumulative scanning time

The total time spent across the scanning phase of this recipe.

99th percentile scanning time

99 out of 100 scans completed in this amount of time.

Max scanning time

The max time scanning any one source file.

Cumulative edit time

The total time spent across the editing phase of this recipe.

99th percentile edit time

99 out of 100 edits completed in this amount of time.

Max edit time

The max time editing any one source file.

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.ChangeDependencyExample. 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.ChangeDependencyExample
displayName: Change Gradle dependency example
recipeList:
  - org.openrewrite.gradle.ChangeDependency:
      oldGroupId: org.openrewrite.recipe
      oldArtifactId: rewrite-testing-frameworks
      newGroupId: corp.internal.openrewrite.recipe
      newArtifactId: rewrite-testing-frameworks
      newVersion: 29.X
      versionPattern: '-jre'

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

Add the following to your build.gradle file:

build.gradle

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

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

repositories {
    mavenCentral()
}

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 ChangeDependencyExample

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, Joan Viladrosa, Jonathan Schnéider, Sam Snyder, Tim te Beek

PreviousChange Extra Property NextChange Gradle dependency artifact

Last updated 10 days ago