Skip to content

Gradle Plugin Convention

GradlePluginConvention

The plugin applies configuration for Gradle plugin development to ease configuration effort. It sets Java 11 support, default dependencies, tests and coverage settings. It also enables explicit API mode for Kotlin.

Requirements

  • Gradle 7.2+

Installation

Add the following to your project module build.gradle/build.gradle.kts file:

plugins {
    id("eu.bitfunk.gradle.plugin.development.convention")
}

The plugin configures publishing and needs to be setup:

  • publishName: Name of the plugin
  • publishDescription: Description of the plugin
  • publishGitHubOrganization: GitHub organisation/account name
  • publishGitHubRepositoryName: GitHub repository name
projectConfig {
    publishName.set("PLUGIN_NAME")
    publishDescription.set("PLUGIN_DESCRIPTION")
    publishGitHubOrganization.set("PLUGIN_GITHUB_ORG")
    publishGitHubRepositoryName.set("PLUGIN_GITHUB_REPOSITORY")
}

Usage

When the plugin is applied, the project is configured with JUnit5 for testing and Kotlin as development language.

Just start to develop and test your GradlePlugin with minimal configuration effort.