Add Maven parent
org.openrewrite.maven.AddParentPom
Add a parent pom to a Maven pom.xml. Does nothing if a parent pom is already present.
Recipe source
GitHub, Issue Tracker, Maven Central
- groupId: org.openrewrite
- artifactId: rewrite-maven
- version: 8.36.0
Options
Type | Name | Description | Example |
---|---|---|---|
String | groupId | The group ID of the maven parent pom to be adopted. | org.springframework.boot |
String | artifactId | The artifact ID of the maven parent pom to be adopted. | spring-boot-starter-parent |
String | version | An exact version number or node-style semver selector used to select the version number. | 29.X |
String | relativePath | New relative path attribute for parent lookup. | ../pom.xml |
String | versionPattern | Optional. Allows version selection to be extended beyond the original Node Semver semantics. So for example,Setting 'version' to "25-29" can be paired with a metadata pattern of "-jre" to select Guava 29.0-jre | -jre |
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.AddParentPomExample
.
Here's how you can define and customize such a recipe within your rewrite.yml:
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddParentPomExample
displayName: Add Maven parent example
recipeList:
- org.openrewrite.maven.AddParentPom:
groupId: org.springframework.boot
artifactId: spring-boot-starter-parent
version: 29.X
relativePath: ../pom.xml
versionPattern: '-jre'
Now that com.yourorg.AddParentPomExample
has been defined, activate it in your build file:
- Maven
- Moderne CLI
- Add the following to your
pom.xml
file:
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.41.0</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>com.yourorg.AddParentPomExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
- Run
mvn rewrite:run
to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
mod run . --recipe AddParentPomExample
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.
Data Tables
Maven metadata failures
org.openrewrite.maven.table.MavenMetadataFailures
Attempts to resolve maven metadata that failed.
Column Name | Description |
---|---|
Group id | The groupId of the artifact for which the metadata download failed. |
Artifact id | The artifactId of the artifact for which the metadata download failed. |
Version | The version of the artifact for which the metadata download failed. |
Maven repository | The URL of the Maven repository that the metadata download failed on. |
Snapshots | Does the repository support snapshots. |
Releases | Does the repository support releases. |
Failure | The reason the metadata download failed. |
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
Column Name | Description |
---|---|
Source path before the run | The source path of the file before the run. null when a source file was created during the run. |
Source path after the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
Recipe that made changes | The specific recipe that made a change. |
Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
Cycle | The recipe cycle in which the change was made. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
Column Name | Description |
---|---|
Source path | The file that failed to parse. |
Recipe that made changes | The specific recipe that made a change. |
Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStats
Statistics used in analyzing the performance of recipes.
Column Name | Description |
---|---|
The recipe | The recipe whose stats are being measured both individually and cumulatively. |
Source file count | The number of source files the recipe ran over. |
Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
Cumulative scanning time | The total time spent across the scanning phase of this recipe. |
99th percentile scanning time | 99 out of 100 scans completed in this amount of time. |
Max scanning time | The max time scanning any one source file. |
Cumulative edit time | The total time spent across the editing phase of this recipe. |
99th percentile edit time | 99 out of 100 edits completed in this amount of time. |
Max edit time | The max time editing any one source file. |