Skip to main content

List effective Maven repositories

org.openrewrite.maven.search.EffectiveMavenRepositories

Lists the Maven repositories that would be used for dependency resolution, in order of precedence. This includes Maven repositories defined in the Maven settings file (and those contributed by active profiles) as determined when the LST was produced.

Recipe source

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options

TypeNameDescriptionExample
BooleanuseMarkersOptional. Whether to add markers for each effective Maven repository to the POM. Default false.

Example

Parameters
ParameterValue
useMarkerstrue
Before
pom.xml
<project>
<groupId>org.openrewrite.example</groupId>
<artifactId>my-app</artifactId>
<version>1</version>
</project>
After
pom.xml
<!--~~(https://repo.maven.apache.org/maven2)~~>--><project>
<groupId>org.openrewrite.example</groupId>
<artifactId>my-app</artifactId>
<version>1</version>
</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.

  1. Add the following to your pom.xml file:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>6.8.0</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>org.openrewrite.maven.search.EffectiveMavenRepositories</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
  1. 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

Effective Maven repositories

org.openrewrite.maven.search.EffectiveMavenRepositoriesTable

Table showing which Maven repositories were used in dependency resolution for this POM.

Column NameDescription
POM pathThe path to the POM file.
Repository URIThe URI of the Maven repository.

Contributors

Jonathan Schneider, Sam Snyder, Kevin Carpenter™️, Tim te Beek, Mike Solomon