Skip to main content

Change property key

org.openrewrite.yaml.ChangePropertyKey

Change a YAML property key while leaving the value intact. 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
StringoldPropertyKeyThe property key to rename. Supports glob patterns.management.metrics.binders.*.enabled
StringnewPropertyKeyThe new name for the property key.management.metrics.enable.process.files
BooleanrelaxedBindingOptional. Whether to match the oldPropertyKey using relaxed binding rules. Defaults to true. If you want to use exact matching in your search, set this to false.
ListexceptOptional. If any of these property keys exist as direct children of oldPropertyKey, then they will not be moved to newPropertyKey.List.of("group")
StringfilePatternOptional. A glob expression representing a file path to search for (relative to the project root). Blank/null matches all..github/workflows/*.yml

Examples

Example 1
Parameters
ParameterValue
oldPropertyKeymanagement.metrics.binders.*.enabled
newPropertyKeymanagement.metrics.enable.process.files
relaxedBindingnull
exceptnull
filePatternnull
Before
management.metrics.binders.files.enabled: true
After
management.metrics.enable.process.files: true

Example 2
Parameters
ParameterValue
oldPropertyKeya.b.c.d
newPropertyKeya.b.c
relaxedBindingnull
exceptnull
filePatternnull
Before
a.b.c.d: true
After
a.b.c: true

Example 3
Parameters
ParameterValue
oldPropertyKeyspring.profiles
newPropertyKeyspring.config.activate.on-profile
relaxedBindingnull
exceptnull
filePatternnull
Before
spring.profiles.group.prod: proddb,prodmq,prodmetrics
After
spring.config.activate.on-profile.group.prod: proddb,prodmq,prodmetrics

Example 4
Parameters
ParameterValue
oldPropertyKeyspring.profiles
newPropertyKeyspring.config.activate.on-profile
relaxedBindingnull
exceptList.of("group", "active", "include")
filePatternnull
Before
spring:
profiles:
active: allEnvs
include: baseProfile
foo: bar
group:
prod: proddb,prodmq,prodmetrics
After
spring:
profiles:
active: allEnvs
include: baseProfile
group:
prod: proddb,prodmq,prodmetrics
config.activate.on-profile:
foo: 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.ChangePropertyKeyExample. 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.ChangePropertyKeyExample
displayName: Change property key example
recipeList:
- org.openrewrite.yaml.ChangePropertyKey:
oldPropertyKey: management.metrics.binders.*.enabled
newPropertyKey: management.metrics.enable.process.files
except: List.of("group")
filePattern: .github/workflows/*.yml

Now that com.yourorg.ChangePropertyKeyExample 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.0")
}

rewrite {
activeRecipe("com.yourorg.ChangePropertyKeyExample")
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, Jonathan Leitschuh, Patrick, Sam Snyder, Tim te Beek, Jonathan Schnéider, Tracey Yoshima, Mike Solomon, Sandeep Nagaraj, Thomas Zub, Greg Oledzki, Jacob van Lingen