Change property key
Recipe ID
org.openrewrite.yaml.ChangePropertyKeyArtifact
org.openrewrite:rewrite-yamlChange 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.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.yaml.ChangePropertyKey --recipe-option "oldPropertyKey=management.metrics.binders.*.enabled" --recipe-option "newPropertyKey=management.metrics.enable.process.files"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite:rewrite-yaml:8.88.0Options
| Name | Type | Description |
|---|---|---|
oldPropertyKeyrequired | String | The property key to rename. Supports glob patterns. e.g. management.metrics.binders.*.enabled |
newPropertyKeyrequired | String | The new name for the property key. e.g. management.metrics.enable.process.files |
relaxedBinding | Boolean | 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. |
except | List | If any of these property keys exist as direct children of oldPropertyKey, then they will not be moved to newPropertyKey.e.g. List.of("group") |
filePattern | String | A glob expression representing a file path to search for (relative to the project root). Blank/null matches all. e.g. .github/workflows/*.yml |
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