← All recipes
Moderne licensed

Change the value of a spring application property

Recipe IDorg.openrewrite.java.spring.ChangeSpringPropertyValueArtifactorg.openrewrite.recipe:rewrite-spring

Change Spring application property values existing in either Properties or YAML files, and in @Value, @ConditionalOnProperty, @SpringBootTest, or @TestPropertySource annotations.

Single recipeMSAL

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.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.java.spring.ChangeSpringPropertyValue")
}

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.recipe:rewrite-spring:6.40.0")
}

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.java.spring.ChangeSpringPropertyValue --recipe-option "propertyKey=management.metrics.binders.files.enabled" --recipe-option "newValue=management.metrics.enable.process.files"

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

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

Options

NameTypeDescription
propertyKeyrequiredStringThe name of the property key whose value is to be changed.
e.g. management.metrics.binders.files.enabled
newValuerequiredStringThe new value to be used for key specified by propertyKey.
e.g. management.metrics.enable.process.files
oldValueStringOnly change the property value if it matches the configured oldValue.
e.g. false
regexBooleanDefault false. If enabled, oldValue will be interpreted as a Regular Expression, and capture group contents will be available in newValue
relaxedBindingBooleanWhether to match the propertyKey using relaxed binding rules. Default is true. Set to false to use exact matching.

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