← All recipes
Open source

Maven parent insight

Recipe IDorg.openrewrite.maven.search.ParentPomInsightArtifactorg.openrewrite:rewrite-maven

Find Maven parents matching a groupId and artifactId.

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.maven.search.ParentPomInsight")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-maven:8.92.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.maven.search.ParentPomInsight --recipe-option "groupIdPattern=org.springframework.boot" --recipe-option "artifactIdPattern=spring-boot-starter-*"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite:rewrite-maven:RELEASE

Options

NameTypeDescription
groupIdPatternrequiredStringGroup glob pattern used to match dependencies.
e.g. org.springframework.boot
artifactIdPatternrequiredStringArtifact glob pattern used to match dependencies.
e.g. spring-boot-starter-*
versionStringMatch only dependencies with the specified version. Node-style version selectors may be used.All versions are searched by default.
e.g. 1.x
recursiveBooleanWhether to search recursively through the parents. True by default.

Data tables

Structured output this recipe can produce.

  • Maven parent POMs in useProjects, GAVs and relativePaths for Maven parent POMs in use.org.openrewrite.maven.table.ParentPomsInUse
  • 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