Skip to main content

Merge YAML snippet

org.openrewrite.yaml.MergeYaml

Merge a YAML snippet with an existing YAML document.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringkeyA JsonPath expression used to find matching keys.$.metadata
StringyamlThe YAML snippet to insert. The snippet will be indented to match the style of its surroundings.
labels:
  label-one: "value-one"
BooleanacceptTheirsOptional. 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.
StringobjectIdentifyingPropertyOptional. 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
StringfilePatternOptional. A glob expression representing a file path to search for (relative to the project root). Blank/null matches all..github/workflows/*.yml
InsertModeinsertModeOptional. Choose an insertion point when multiple mappings exist. Default is Last. Valid options: Before, After, Last
StringinsertPropertyOptional. Define the key for the insertion mode. Takes the key JsonPath into account. Only useful when insert mode is either Before or After.some-key
BooleancreateNewKeysOptional. When the key path does not match any keys, create new keys on the spot. Default is true.

Example​

Parameters​
ParameterValue
key$.spec
yaml`lifecycleRule:
  • action: type: Delete condition: age: 7 | |acceptTheirs|false| |objectIdentifyingProperty|null| |filePattern|null| |insertMode|null| |insertProperty|null| |createNewKeys|null`|
Before​
apiVersion: storage.cnrm.cloud.google.com/v1beta1
kind: StorageBucket
spec:
    bucketPolicyOnly: true
After​
apiVersion: storage.cnrm.cloud.google.com/v1beta1
kind: StorageBucket
spec:
    bucketPolicyOnly: true
    lifecycleRule:
        - action:
              type: Delete
          condition:
              age: 7

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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
      filePattern: .github/workflows/*.yml
      insertProperty: some-key

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("7.7.0")
}

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

repositories {
    mavenCentral()
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Jacob van Lingen, Jonathan Schneider, Jon Brisbin, Sam Snyder, Dmitry Belyaev, adastraperangusta, Greg Oledzki, Tim te Beek, Knut Wannheden, Jonathan Leitschuh, Aaron Gershman