Change YAML property
Recipe ID
org.openrewrite.yaml.ChangePropertyValueArtifact
org.openrewrite:rewrite-yamlChange a YAML property. 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.ChangePropertyValue --recipe-option "propertyKey=management.metrics.binders.*.enabled" --recipe-option "newValue=newValue"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 |
|---|---|---|
propertyKeyrequired | String | The key to look for. Supports glob patterns. e.g. management.metrics.binders.*.enabled |
newValuerequired | String | The new value to be used for key specified by propertyKey.e.g. newValue |
oldValue | String | Only change the property value if it matches the configured oldValue.e.g. oldValue |
regex | Boolean | 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. |
relaxedBinding | Boolean | Whether to match the propertyKey using relaxed binding rules. Default is true. Set to false to use exact matching. |
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