Add a comment to a Maven dependency or plugin
Recipe ID
org.openrewrite.maven.AddCommentToMavenDependencyArtifact
org.openrewrite:rewrite-mavenAdds a comment as the first element in a Maven dependency or plugin.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.maven.AddCommentToMavenDependency --recipe-option "xPath=/project/dependencies/dependency" --recipe-option "groupId=com.google.guava" --recipe-option "artifactId=guava" --recipe-option "commentText=This is excluded due to CVE <X> and will be removed when we upgrade the next version is available."If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite:rewrite-maven:8.88.0Options
| Name | Type | Description |
|---|---|---|
xPathrequired | String | An XPath expression used to find matching tags. e.g. /project/dependencies/dependency |
groupIdrequired | String | The first part of a dependency coordinate com.google.guava:guava:VERSION.e.g. com.google.guava |
artifactIdrequired | String | The second part of a dependency coordinate com.google.guava:guava:VERSION.e.g. guava |
commentTextrequired | String | The text to add as a comment.. e.g. This is excluded due to CVE <X> and will be removed when we upgrade the next version is available. |
Data tables
Structured output this recipe can produce.
- Source files that had resultsSource files that were modified by the recipe run.
org.openrewrite.table.SourcesFileResults - Source files that had search resultsSearch results that were found during the recipe run.
org.openrewrite.table.SearchResults - Source files that errored on a recipeThe details of all errors produced by a recipe run.
org.openrewrite.table.SourcesFileErrors - Recipe performanceStatistics used in analyzing the performance of recipes.
org.openrewrite.table.RecipeRunStats