mergeyaml.md

Merge YAML snippet

org.openrewrite.yaml.MergeYaml

Merge a YAML snippet with an existing YAML document.

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite
• artifactId: rewrite-yaml
• version: 8.1.3

Options

Type	Name	Description
String	key	A JsonPath expression used to find matching keys.
String	yaml	The YAML snippet to insert. The snippet will be indented to match the style of its surroundings.
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.

Example

Parameters

Parameter	Value
key	$.spec
yaml	`lifecycleRule:

- action:
      type: Delete
  condition:
      age: 7

| |acceptTheirs|false| |objectIdentifyingProperty|null`|

{% tabs %} {% tab title="yaml" %}

Before

{% code %}

apiVersion: storage.cnrm.cloud.google.com/v1beta1
kind: StorageBucket
spec:
    bucketPolicyOnly: true

{% endcode %}

After

{% code %}

apiVersion: storage.cnrm.cloud.google.com/v1beta1
kind: StorageBucket
spec:
    bucketPolicyOnly: true
    lifecycleRule:
        - action:
              type: Delete
          condition:
              age: 7

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

@@ -5,0 +5,5 @@
spec:
    bucketPolicyOnly: true
+   lifecycleRule:
+       - action:
+             type: Delete
+         condition:
+             age: 7

{% endcode %} {% endtab %} {% endtabs %}

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:

{% code title="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"
      acceptTheirs: null
      objectIdentifyingProperty: name

{% endcode %}

Now that com.yourorg.MergeYamlExample has been defined activate it in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

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

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %} {% tab title="Maven" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.MergeYamlExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Jonathan Schneider
• Jon Brisbin
• Dmitry Belyaev
• Aaron Gershman
• Jonathan Leitschuh

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.