addbuildplugin.md

Add a Gradle build plugin

org.openrewrite.gradle.plugins.AddBuildPlugin

Add a Gradle build plugin to build.gradle(.kts).

Source

GitHub, Issue Tracker, Maven Central

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

Options

Type	Name	Description
String	pluginId	The plugin id to apply.
String	version	Optional. An exact version number or node-style semver selector used to select the version number.
String	versionPattern	Optional. Allows version selection to be extended beyond the original Node Semver semantics. So for example,Setting 'version' to "25-29" can be paired with a metadata pattern of "-jre" to select Guava 29.0-jre

Example

Parameters

Parameter	Value
pluginId	java-library
version	null
versionPattern	null

Before

{% code title="build.gradle" %}

null```
{% endcode %}

###### New file
{% code title="build.gradle" %}
```groovy
plugins {
    id 'java-library'
}

{% endcode %}

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.AddBuildPluginExample. Here's how you can define and customize such a recipe within your rewrite.yml:

{% code title="rewrite.yml" %}

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddBuildPluginExample
displayName: Add a Gradle build plugin example
recipeList:
  - org.openrewrite.gradle.plugins.AddBuildPlugin:
      pluginId: com.jfrog.bintray
      version: 3.x
      versionPattern: '-jre'

{% endcode %}

Now that com.yourorg.AddBuildPluginExample has been defined activate it in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

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

rewrite {
    activeRecipe("com.yourorg.AddBuildPluginExample")
}

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %}

{% endtabs %}

Contributors

• Shannon Pamperl
• Sam Snyder
• Jonathan Schnéider

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.