dev.gradleplugins

Interface GradlePluginDevelopmentCompatibilityExtension

public interface GradlePluginDevelopmentCompatibilityExtension

An extension for controlling the Gradle plugin development compatibility. The extension is registered on the gradlePlugin extension.

Method Summary

Modifier and Type	Method and Description
static GradlePluginDevelopmentCompatibilityExtension	compatibility(org.gradle.plugin.devel.GradlePluginDevelopmentExtension extension) Returns compatibility extension from Gradle plugin development extension.
org.gradle.api.provider.Property<java.lang.String>	getGradleApiVersion() Configures the Gradle API version to compile against.
org.gradle.api.provider.Property<java.lang.String>	getMinimumGradleVersion() Configures the minimum Gradle version.

Method Detail

getMinimumGradleVersion

org.gradle.api.provider.Property<java.lang.String> getMinimumGradleVersion()

Configures the minimum Gradle version.

Returns:

a property to configure the minimum support Gradle version, never null.

getGradleApiVersion

org.gradle.api.provider.Property<java.lang.String> getGradleApiVersion()

Configures the Gradle API version to compile against. Defaults to minimum Gradle version for non snapshot versions and local for snapshot version. Use local to use the Gradle API JAR generated for the current distribution. WARNING: We don't recommend using the local Gradle API version as it lack support for source configuration and Groovy/Kotlin version alignment.

Returns:

a property to configure the Gradle API version to use, never null

compatibility

static GradlePluginDevelopmentCompatibilityExtension compatibility(org.gradle.plugin.devel.GradlePluginDevelopmentExtension extension)

Returns compatibility extension from Gradle plugin development extension. The plugin dev.gradleplugins.base registers this extension.

Parameters:

extension - the gradlePlugin extension, must not be null

Returns:

the compatibility extension, never null