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

TypeNameDescriptionExample

String

key

A JsonPath expression used to find matching keys.

$.metadata

String

yaml

The YAML snippet to insert. The snippet will be indented to match the style of its surroundings.

labels: 
	label-one: "value-one"

Boolean

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.

String

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.

name

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:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.MergeYamlExample
displayName: Merge YAML snippet example
recipeList:
  - org.openrewrite.yaml.MergeYaml:
      key: $.metadata
      yaml: labels: 
	label-one: "value-one"
      objectIdentifyingProperty: name

Now that com.yourorg.MergeYamlExample 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("6.10.0")
}

rewrite {
    activeRecipe("com.yourorg.MergeYamlExample")
}

repositories {
    mavenCentral()
}
  1. 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