Skip to main content

Maven repository order

org.openrewrite.maven.search.FindRepositoryOrder

Determine the order in which dependencies will be resolved for each pom.xml based on its defined repositories and effective settings.xml.

Recipe source​

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

This recipe is available under the Apache License Version 2.0.

Example​

Before​
pom.xml
<project>
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.5.12.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
  <repositories>
    <repository>
      <id>myRepo</id>
      <url>https://myrepo.maven.com/repo</url>
    </repository>
  </repositories>
</project>
After​
pom.xml
<!--~~(https://myrepo.maven.com/repo
https://repo.spring.io/milestone)~~>--><project>
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.5.12.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
  <repositories>
    <repository>
      <id>myRepo</id>
      <url>https://myrepo.maven.com/repo</url>
    </repository>
  </repositories>
</project>

Usage​

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies.

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. Add the Code Genome Project credentials to your Maven settings.xml file (typically at ~/.m2/settings.xml), replacing USERNAME and TOKEN with your own:
    settings.xml
    <settings>
      <servers>
        <server>
          <id>codegenome</id>
          <username>USERNAME</username>
          <password>TOKEN</password>
        </server>
      </servers>
    </settings>
  2. Add the following to your pom.xml file:
    pom.xml
    <project>
      <repositories>
        <repository>
          <id>codegenome</id>
          <url>https://artifacts.codegenomeproject.org/maven</url>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>codegenome</id>
          <url>https://artifacts.codegenomeproject.org/maven</url>
        </pluginRepository>
      </pluginRepositories>
      <build>
        <plugins>
          <plugin>
            <groupId>org.openrewrite.maven</groupId>
            <artifactId>rewrite-maven-plugin</artifactId>
            <version>6.47.0</version>
            <configuration>
              <exportDatatables>true</exportDatatables>
              <activeRecipes>
                <recipe>org.openrewrite.maven.search.FindRepositoryOrder</recipe>
              </activeRecipes>
            </configuration>
          </plugin>
        </plugins>
      </build>
    </project>
  3. Run mvn rewrite:run 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​

Maven repository order​

org.openrewrite.maven.table.MavenRepositoryOrder

The order in which dependencies will be resolved for each pom.xml based on its defined repositories and effective settings.xml.

Column NameDescription
Repository IDThe ID of the repository. Note that projects may define the same physical repository with different IDs.
Repository URIThe URI of the repository.
Known to existIf the repository is provably reachable. If false, does not guarantee that the repository does not exist.
RankThe index order of this repository in the repository list.