Skip to main content

Maven parent insight

org.openrewrite.maven.search.ParentPomInsight

Find Maven parents matching a groupId and artifactId.

Recipe source​

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

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringgroupIdPatternGroup glob pattern used to match dependencies.org.springframework.boot
StringartifactIdPatternArtifact glob pattern used to match dependencies.spring-boot-starter-*
StringversionOptional. Match only dependencies with the specified version. Node-style version selectors may be used.All versions are searched by default.1.x
BooleanrecursiveOptional. Whether to search recursively through the parents. True by default.

Example​

Parameters​
ParameterValue
groupIdPatternorg.springframework.boot
artifactIdPatternspring-boot-starter-parent
versionnull
recursivenull
Unchanged​
demo
Before​
pom.xml
<project>
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>3.1.4</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>demo</artifactId>
	<version>0.0.1-SNAPSHOT</version>
</project>
After​
pom.xml
<project>
	<modelVersion>4.0.0</modelVersion>
	<!--~~>--><parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>3.1.4</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>demo</artifactId>
	<version>0.0.1-SNAPSHOT</version>
</project>

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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.ParentPomInsightExample. 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.ParentPomInsightExample
displayName: Maven parent insight example
recipeList:
  - org.openrewrite.maven.search.ParentPomInsight:
      groupIdPattern: org.springframework.boot
      artifactIdPattern: spring-boot-starter-*
      version: 1.x

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

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

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.50.0</version>
            <configuration>
              <exportDatatables>true</exportDatatables>
              <activeRecipes>
                <recipe>com.yourorg.ParentPomInsightExample</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 parent POMs in use​

org.openrewrite.maven.table.ParentPomsInUse

Projects, GAVs and relativePaths for Maven parent POMs in use.

Column NameDescription
Project artifactIdThe artifactId of the project that contains the parent.
GroupThe first part of a parent coordinate org.springframework.boot.
ArtifactThe second part of a parent coordinate spring-boot-starter-*.
VersionThe resolved version.
Relative pathThe relative path to the parent.