Skip to main content

Find relocated dependencies

org.openrewrite.java.dependencies.RelocatedDependencyCheck

Find Maven and Gradle dependencies and Maven plugins that have relocated to a new groupId or artifactId. Relocation information comes from the oga-maven-plugin maintained by Jonathan Lermitage, Filipe Roque and others. This recipe makes no changes to any source file by default. Add changeDependencies=true to change dependencies, but note that you might need to run additional recipes to update imports and adopt other breaking changes.

Recipe source​

GitHub: RelocatedDependencyCheck.java, Issue Tracker, Code Genome Project

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
BooleanchangeDependenciesOptional. Whether to change dependencies to their relocated groupId and artifactId.

Example​

Parameters​
ParameterValue
changeDependenciesnull
Before​
pom.xml
<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.openrewrite.example</groupId>
  <artifactId>rewrite-example</artifactId>
  <version>1.0-SNAPSHOT</version>
  <dependencies>
    <dependency>
      <groupId>commons-lang</groupId>
      <artifactId>commons-lang</artifactId>
      <version>2.6</version>
    </dependency>
    <dependency>
      <groupId>org.codehaus.groovy</groupId>
      <artifactId>groovy</artifactId>
      <version>2.5.6</version>
    </dependency>
  </dependencies>
</project>
After​
pom.xml
<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.openrewrite.example</groupId>
  <artifactId>rewrite-example</artifactId>
  <version>1.0-SNAPSHOT</version>
  <dependencies>
    <!--~~(Relocated to org.apache.commons:commons-lang3)~~>--><dependency>
      <groupId>commons-lang</groupId>
      <artifactId>commons-lang</artifactId>
      <version>2.6</version>
    </dependency>
    <!--~~(Relocated to org.apache.groovy)~~>--><dependency>
      <groupId>org.codehaus.groovy</groupId>
      <artifactId>groovy</artifactId>
      <version>2.5.6</version>
    </dependency>
  </dependencies>
</project>

Usage​

This recipe has no required configuration options. It can be activated by adding a dependency on `org.openrewrite.recipe:rewrite-java-dependencies` in your build file or by running a shell command (in which case no build changes are needed):

OpenRewrite artifacts, including the Maven and Gradle plugins themselves, are distributed through the Code Genome Project repository (https://artifacts.codegenomeproject.org/maven), which requires authentication. Sign in to the Code Genome Project to create a download token; your build authenticates with the email or username you signed in with, plus that token as the password. See the quickstart guide for details.

  1. Put your Code Genome Project credentials in ~/.gradle/gradle.properties, so that they are not committed alongside your build:
    ~/.gradle/gradle.properties
    codeGenomeUsername=you@example.com
    codeGenomeToken=your-download-token
  2. Add the Code Genome Project repository to your settings.gradle file, so that the plugin itself can be resolved:
    settings.gradle
    pluginManagement {
        repositories {
            maven {
                url = "https://artifacts.codegenomeproject.org/maven"
                credentials {
                    username = providers.gradleProperty("codeGenomeUsername").get()
                    password = providers.gradleProperty("codeGenomeToken").get()
                }
            }
            // Keep the portal for any other plugins your build applies
            gradlePluginPortal()
        }
    }
  3. Add the following to your build.gradle file:
    build.gradle
    plugins {
        id("org.openrewrite.rewrite") version("latest.release")
    }

    rewrite {
        activeRecipe("org.openrewrite.java.dependencies.RelocatedDependencyCheck")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
        maven {
            url = "https://artifacts.codegenomeproject.org/maven"
            credentials {
                username = providers.gradleProperty("codeGenomeUsername").get()
                password = providers.gradleProperty("codeGenomeToken").get()
            }
        }
    }

    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-java-dependencies:1.63.0")
    }
  4. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Relocated dependencies​

org.openrewrite.java.dependencies.table.RelocatedDependencyReport

A list of dependencies in use that have relocated.

Column NameDescription
Dependency group idThe Group ID of the dependency in use.
Dependency artifact idThe Artifact ID of the dependency in use.
Relocated dependency group idThe Group ID of the relocated dependency.
Relocated ependency artifact idThe Artifact ID of the relocated dependency.
ContextContext for the relocation, if any.