Open source

Add comment to a YAML property

Recipe IDorg.openrewrite.yaml.AddCommentToPropertyArtifactorg.openrewrite:rewrite-yaml

Add a comment to a YAML property. The comment will be added on the line before the property.

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

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

rewrite {
    activeRecipe("org.openrewrite.yaml.AddCommentToProperty")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-yaml:8.92.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.yaml.AddCommentToProperty --recipe-option "propertyKey=management.metrics.binders.*.enabled" --recipe-option "comment=This property is deprecated"

If the recipe isn’t available locally, install it with:

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

Options

Name	Type	Description
`propertyKey`required	`String`	The property key to add a comment to. Supports glob patterns. e.g. `management.metrics.binders.*.enabled`
`comment`required	`String`	The comment to add to the property. e.g. `This property is deprecated`
`relaxedBinding`	`Boolean`	Whether to match the `propertyKey` using relaxed binding rules. Defaults to `true`. If you want to use exact matching in your search, set this to `false`.
`filePattern`	`String`	A glob expression representing a file path to search for (relative to the project root). Blank/null matches all. e.g. `.github/workflows/*.yml`

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats