Links

Change YAML property

org.openrewrite.yaml.ChangePropertyValue
Change a YAML property. Expects dot notation for nested YAML mappings, similar to how Spring Boot interprets application.yml files.

Recipe source

  • groupId: org.openrewrite
  • artifactId: rewrite-yaml
  • version: 8.17.1

Options

Type
Name
Description
Example
String
propertyKey
The key to look for. Supports glob patterns.
management.metrics.binders.*.enabled
String
newValue
The new value to be used for key specified by propertyKey.
String
oldValue
Optional. Only change the property value if it matches the configured oldValue.
Boolean
regex
Optional. Default false. If enabled, oldValue will be interpreted as a Regular Expression, to replace only all parts that match the regex. Capturing group can be used 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.ChangePropertyValueExample. 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.ChangePropertyValueExample
displayName: Change YAML property example
recipeList:
- org.openrewrite.yaml.ChangePropertyValue:
propertyKey: management.metrics.binders.*.enabled
newValue: null
Now that com.yourorg.ChangePropertyValueExample has been defined activate it in your build file:
Gradle
Maven
Moderne CLI
  1. 1.
    Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.8.4")
}
rewrite {
activeRecipe("com.yourorg.ChangePropertyValueExample")
}
repositories {
mavenCentral()
}
  1. 2.
    Run gradle rewriteRun to run the recipe.
  1. 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.23.1</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ChangePropertyValueExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe ChangePropertyValueExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
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