← All recipes
Open source

Sync Gradle ext properties with BOM

Recipe IDorg.openrewrite.gradle.SyncGradleExtPropertiesWithBom
Artifactorg.openrewrite:rewrite-gradle

Downloads a BOM and compares its properties against Gradle ext properties. When the BOM defines a higher version for a property, the ext property is updated to match (or removed if removeRedundantOverrides is enabled).

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.gradle.SyncGradleExtPropertiesWithBom --recipe-option "groupId=org.springframework.boot" --recipe-option "artifactId=spring-boot-dependencies" --recipe-option "version=3.4.0"

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

mod config recipes jar install org.openrewrite:rewrite-gradle:8.88.0

Options

NameTypeDescription
groupIdrequiredStringThe groupId of the BOM to sync with.
e.g. org.springframework.boot
artifactIdrequiredStringThe artifactId of the BOM to sync with.
e.g. spring-boot-dependencies
versionrequiredStringThe version of the BOM to sync with.
e.g. 3.4.0
removeRedundantOverridesBooleanWhen enabled, ext properties whose value is lower than or equal to the BOM version will be removed entirely instead of updated, since the BOM default is now sufficient.

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