Maven parent insight

org.openrewrite.maven.search.ParentPomInsight

Find Maven parents matching a groupId and artifactId.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-maven

• version: 8.24.0

Options

Type	Name	Description	Example
String	groupIdPattern	Group glob pattern used to match dependencies.	org.springframework.boot
String	artifactIdPattern	Artifact glob pattern used to match dependencies.	spring-boot-starter-*
String	version	Optional. Match only dependencies with the specified version. Node-style version selectors may be used.All versions are searched by default.	1.x

Data Tables (Only available on the Moderne platform)

Maven parent POMs in use

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

Column Name	Description
Project artifactId	The artifactId of the project that contains the parent.
Group	The first part of a parent coordinate org.springframework.boot.
Artifact	The second part of a parent coordinate spring-boot-starter-*.
Version	The resolved version.
Relative path	The relative path to the parent.

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.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

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

Maven

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>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ParentPomInsightExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe ParentPomInsightExample

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

Tim te Beek, Jonathan Schnéider