Open source

Merge YAML snippet

Recipe IDorg.openrewrite.yaml.MergeYaml

Artifactorg.openrewrite:rewrite-yaml

Merge a YAML snippet with an existing YAML document.

Single recipeYAMLApache License Version 2.0

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

8 parameters

2 required6 optional

Parameter	Example	Type	Required
key	$.metadata	String	Required
A [JsonPath](https://docs.openrewrite.org/reference/jsonpath-and-jsonpathmatcher-reference) expression used to find matching keys.
yaml	labels: label-one: "value-one"	String	Required
The YAML snippet to insert. The snippet will be indented to match the style of its surroundings.
acceptTheirs	—	Boolean	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.
createNewKeys	—	Boolean	Optional
When the key path does _not_ match any keys, create new keys on the spot. Default is true.
filePattern	.github/workflows/*.yml	String	Optional
A glob expression representing a file path to search for (relative to the project root). Blank/null matches all.
insertMode	—	InsertMode	Optional
Choose an insertion point when multiple mappings exist. Default is Last.
insertProperty	some-key	String	Optional
Define the key for the insertion mode. Takes the key JsonPath into account. Only useful when insert mode is either Before or After.
objectIdentifyingProperty	name	String	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.

Examples

yaml

Parameter	Value
key	$.spec
yaml	lifecycleRule: - action: type: Delete condition: age: 7
acceptTheirs	false
objectIdentifyingProperty	null
filePattern	null
insertMode	null
insertProperty	null
createNewKeys	null

yaml

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

Diff

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

Usage

Run this recipe

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe MergeYaml --recipe-option "key=$.metadata" --recipe-option "yaml='labels:
  label-one: "value-one"'" --recipe-option "objectIdentifyingProperty=name" --recipe-option "filePattern=.github/workflows/*.yml" --recipe-option "insertProperty=some-key"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-yaml:8.85.6

Data tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A 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 changes	In 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 changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.