Comment on page

Append to sequence

org.openrewrite.yaml.AppendToSequence
Append item to YAML sequence.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-yaml
version: 8.9.5
Options
Type
Name
Description
String
sequencePath
A JsonPath expression to locate a YAML sequence.
String
value
The new value to be appended to the sequence.
List
existingSequenceValues
Optional. If specified, the item will only be appended if the existing sequence matches these values.
Boolean
matchExistingSequenceValuesInAnyOrder
Optional. If specified in combination with the above parameter, the item will only be appended if the existing sequence has the specified values in any order.
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.AppendToSequenceExample. 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.AppendToSequenceExample
displayName: Append to sequence example
recipeList:
  - org.openrewrite.yaml.AppendToSequence:
      sequencePath: $.universe.planets
      value: earth
      existingSequenceValues: existingValue1
      matchExistingSequenceValuesInAnyOrder: true
Now that com.yourorg.AppendToSequenceExample has been defined activate it in your build file:
Gradle
Maven
Moderne CLI
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.5.6")
}
​
rewrite {
    activeRecipe("com.yourorg.AppendToSequenceExample")
}
​
repositories {
    mavenCentral()
}
2.Run gradle rewriteRun to run the recipe.
1.Add the following to your pom.xml file:
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.AppendToSequenceExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe AppendToSequence
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
​sullis, Jonathan Schnéider, Mike Solomon, Jonathan Leitschuh​

Type	Name	Description
`String`	sequencePath	A JsonPath expression to locate a YAML sequence.
`String`	value	The new value to be appended to the sequence.
`List`	existingSequenceValues	Optional. If specified, the item will only be appended if the existing sequence matches these values.
`Boolean`	matchExistingSequenceValuesInAnyOrder	Optional. If specified in combination with the above parameter, the item will only be appended if the existing sequence has the specified values in any order.

YAML

Change YAML property

Last modified 12d ago