Links
Comment on page

Add Gradle property

org.openrewrite.gradle.AddProperty
Add a property to the gradle.properties file.

Recipe source

  • groupId: org.openrewrite
  • artifactId: rewrite-gradle
  • version: 8.9.5

Options

Type
Name
Description
String
key
The name of the property to add.
String
value
The value of the property to add.
Boolean
overwrite
If a property with the same key exists, overwrite.
String
filePattern
A glob expression that can be used to constrain which directories or source files should be searched. When not set, all source files are searched.

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.AddPropertyExample. 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.AddPropertyExample
displayName: Add Gradle property example
recipeList:
- org.openrewrite.gradle.AddProperty:
key: org.gradle.caching
value: null
overwrite: Enable the Gradle build cache
filePattern: '**/*.properties'
Now that com.yourorg.AddPropertyExample has been defined activate it in your build file:
Gradle
Moderne CLI
  1. 1.
    Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.5.6")
}
rewrite {
activeRecipe("com.yourorg.AddPropertyExample")
}
repositories {
mavenCentral()
}
  1. 2.
    Run gradle rewriteRun 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 AddProperty

See how this recipe works across multiple open-source repositories

Moderne Link Image
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.