Skip to main content

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​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringpropertyKeyThe key to look for. Supports glob patterns.management.metrics.binders.*.enabled
StringnewValueThe new value to be used for key specified by propertyKey.newValue
StringoldValueOptional. Only change the property value if it matches the configured oldValue.oldValue
BooleanregexOptional. 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.
BooleanrelaxedBindingOptional. Whether to match the propertyKey using relaxed binding rules. Default is true. Set to false to use exact matching.
StringfilePatternOptional. A glob expression representing a file path to search for (relative to the project root). Blank/null matches all..github/workflows/*.yml

Example​

Parameters​
ParameterValue
propertyKeymy.prop
newValuebar
oldValuenull
regexnull
relaxedBindingnull
filePatternnull
Before​
my.prop: foo
After​
my.prop: bar

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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: newValue
      oldValue: oldValue
      filePattern: .github/workflows/*.yml

Now that com.yourorg.ChangePropertyValueExample has been defined, activate it in your build file:

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.6.1")
}

rewrite {
    activeRecipe("com.yourorg.ChangePropertyValueExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Nick McKinney, Jente Sondervorst, Sam Snyder, Jonathan Schnéider, Tim te Beek, Mike Solomon