Merge YAML snippet
org.openrewrite.yaml.MergeYaml
Merge a YAML snippet with an existing YAML document.
Recipe source
GitHub, Issue Tracker, Maven Central
groupId: org.openrewrite
artifactId: rewrite-yaml
version: 8.21.0
Options
Type | Name | Description | Example |
---|---|---|---|
| key | A JsonPath expression used to find matching keys. |
|
| yaml | The YAML snippet to insert. The snippet will be indented to match the style of its surroundings. | |
| acceptTheirs | Optional. When the YAML snippet to insert conflicts with an existing key value pair and an existing key has a different value, prefer the original value. | |
| objectIdentifyingProperty | Optional. Name of a property which will be used to identify objects (mapping). This serves as the key to match on when merging entries of a sequence. |
|
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.MergeYamlExample
. Here's how you can define and customize such a recipe within your rewrite.yml:
Now that com.yourorg.MergeYamlExample
has been defined activate it in your build file:
Add the following to your
build.gradle
file:
Run
gradle rewriteRun
to run the recipe.
See how this recipe works across multiple open-source repositories
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
Jonathan Schneider, Jon Brisbin, Knut Wannheden, Sam Snyder, Dmitry Belyaev, Aaron Gershman, Mike Solomon, Jonathan Leitschuh, Tim te Beek
Last updated