Change the value of a spring application property

org.openrewrite.java.spring.ChangeSpringPropertyValue

Change spring application property values existing in either Properties or Yaml files.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-spring

• version: 5.8.0

Options

Type	Name	Description	Example
String	propertyKey	The name of the property key whose value is to be changed.	management.metrics.binders.files.enabled
String	newValue	The new value to be used for key specified by propertyKey.	management.metrics.enable.process.files
String	oldValue	Optional. Only change the property value if it matches the configured oldValue.	false
Boolean	regex	Optional. Default false. If enabled, oldValue will be interpreted as a Regular Expression, and capture group contents will be available in newValue
Boolean	relaxedBinding	Optional. Whether to match the propertyKey using relaxed binding rules. Default is true. Set to false to use exact matching.

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.ChangeSpringPropertyValueExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ChangeSpringPropertyValueExample
displayName: Change the value of a spring application property example
recipeList:
  - org.openrewrite.java.spring.ChangeSpringPropertyValue:
      propertyKey: management.metrics.binders.files.enabled
      newValue: management.metrics.enable.process.files
      oldValue: false

Now that com.yourorg.ChangeSpringPropertyValueExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-spring:5.8.0 in your build file:

Gradle

1. Add the following to your build.gradle file:

build.gradle

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

rewrite {
    activeRecipe("com.yourorg.ChangeSpringPropertyValueExample")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-spring:5.8.0")
}

2. Run gradle rewriteRun to run the recipe.

Maven

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ChangeSpringPropertyValueExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-spring</artifactId>
            <version>5.8.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe ChangeSpringPropertyValueExample

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.

Contributors

Nick McKinney, Knut Wannheden, Tim te Beek, Josh Soref, Jonathan Schnéider