Property Detail

• static final java.lang.String ARTIFACTORY_PLUGIN_ID

• static final java.lang.String BINTRAY_PLUGIN_ID

• static final java.lang.String GRADLE_PLUGIN_PUBLISH_PLUGIN_ID

• static final java.lang.String GRGIT_PLUGIN_ID

• static final java.util.List<java.lang.String> PLUGIN_IDS

  The plugins to apply to the plugin build project.

• static java.util.List<java.lang.String> REQUIRED_PROPERTIES

  The project-specific properties that must be set.

• static final java.lang.String SHADOW_PLUGIN_ID

• java.util.Map<java.lang.String, groovy.lang.Closure<java.lang.Boolean>> pluginInclusion

  Maps plugin identifier to project property. If a plugin identifier is included in this map then the plugin will only be applied if the project property is present with a non-empty value that does not evaluate to false.

Method Detail

• @java.lang.Override void apply(org.gradle.api.Project project)

  Applies the plugin and configures the build.

  Parameters:

  project - The project to configure

• static void checkProjectProperties(org.gradle.api.Project project, java.util.List<java.lang.String> requiredProperties)

  Checks that values have been provided for the required project properties.

  Parameters:

  project - The project to configure

  See Also:

  REQUIRED_PROPERTIES

• static void configureArtifactory(org.gradle.api.Project project)

  Configures Artifactory publishing. Disabled by default. Set artifactoryContextUrl, artifactoryRepoKey, artifactoryUser and artifactoryToken to enable Artifactory publishing.

  Parameters:

  project - The project to configure

• static void configureBintray(org.gradle.api.Project project)

  Configures Bintray publishing. Disabled by default. Set bintrayContextUrl, bintrayUser and bintrayKey to enable Bintray publishing.

  Parameters:

  project - The project to configure

• static void configureDefaultTasks(org.gradle.api.Project project)

  Configures the local and all tasks and assigns all as the project default.

  Parameters:

  project - The project to configure

• static void configureDependencies(org.gradle.api.Project project)

  Adds dependencies.

  Parameters:

  project - The project to configure

• static void configureDerivedPropertiesWithPlugins(org.gradle.api.Project project)

  Configure the properties that we couldn't get values for without plugins.

  Parameters:

  project - The project to configure

• static void configureDerivedPropertiesWithoutPlugins(org.gradle.api.Project project)

  Defines additional properties that are derived from the required properties. Some of these are used when figuring out which plugins to apply.

  Parameters:

  project - The project to configure

• static void configureGradlePlugin(org.gradle.api.Project project)

  Configures the Gradle plugin to build and publish.

  Parameters:

  project - The project to configure

• static void configureJarTask(org.gradle.api.Project project)

  Configures jar task including manifest attributes.

  Parameters:

  project - The project to configure

• static void configureJavaPlugin(org.gradle.api.Project project)

  Configures the Java plugin including source and target compatibility.

  Parameters:

  project - The project to configure

• static void configureJavaPublishing(org.gradle.api.Project project)

  Configures publishing.

  Parameters:

  project - The project to configure

• static void configureJavadocJarTask(org.gradle.api.Project project)

  Configures the Javadoc jar task.

  Parameters:

  project - The project to configure

• static void configurePlugin(org.gradle.api.Project project, java.lang.String id, java.util.Map<java.lang.String, groovy.lang.Closure<java.lang.Boolean>> pluginInclusion)

  Applies the plugin identified by the parameter plugin identifier. If the plugin identifier is included as a key in the pluginInclusion map then it will only be applied if the value is present as a property on the project with a non-empty value.

  Parameters:

  project - The project to apply the plugin to

  id - The identifier of the plugin to apply

  pluginInclusion - Optional losures to check plugin inclusion

• static void configurePluginBundle(org.gradle.api.Project project)

  Configures the plugin bundle being published. Snapshot versions are not published. Projects without an isOpenSource property that evaluates to true are not published.

  Parameters:

  project - The project to configure

• static void configurePluginInclusion(org.gradle.api.Project project, java.util.Map<java.lang.String, groovy.lang.Closure<java.lang.Boolean>> pluginInclusion)

• static void configurePlugins(org.gradle.api.Project project, java.util.List<java.lang.String> pluginIds, java.util.Map<java.lang.String, groovy.lang.Closure<java.lang.Boolean>> pluginInclusion)

  Applies the plugins in the PLUGIN_IDS list.

  Parameters:

  project - The project to configure

  pluginInclusion - Optional losures to check plugin inclusion

  See Also:

  PLUGIN_IDS

• static void configureRepositories(org.gradle.api.Project project)

  Adds repository definitions.

  Parameters:

  project - The project to configure

• static void configureShadowJarTask(org.gradle.api.Project project)

  Configures the shadow jar task.

  Parameters:

  project - The project being configured

• static void configureSourceJarTask(org.gradle.api.Project project)

  Configures the source jar task.

  Parameters:

  project - The project to configure

• static boolean isArtifactoryPublishingEnabled(org.gradle.api.Project project)

  Determines whether produced artifacts should be published to Artifactory.

  As of version 4.16.1, the Artifactory plugin can only be applied to the root project using the plugins { .. } Gradle syntax. When the plugin needs to be applied to subprojects, it has to be included as a build script class path dependency and then applied using the apply plugin: syntax. This plugin only supports applying the Artifactory when configuring a root project. Multi-project builds can instead be explicitly configured with a subprojects { .. } clause in the root project.

  See https://www.jfrog.com/confluence/display/JFROG/Gradle+Artifactory+Plugin.

• static boolean isBintrayPublishingEnabled(org.gradle.api.Project project)

  Determines whether the produced artifacts should be published to Bintray. Bintray publishing is only applicable for open source projects that define the isOpenSource property with the value true. Bintray publishing is enabled when the Bintray URL and credential project properties are provided, and the project build number is not SNAPSHOT. (Bintray does not provide snapshot publishing; attempts to publish snapshots simply crash the build.)

  Parameters:

  project - The project being configured

  Returns:

  True iff artifacts should be published to Bintray

• static boolean isGitHosted(org.gradle.api.Project project)

  Checks whether git integration should be enabled. This is determined by the presence of the isGitHosted project property, with a non-empty value.

  Parameters:

  The - project to check

  Returns:

  True iff git integration is indicated, else false

• static boolean isPluginPublishingEnabled(org.gradle.api.Project project)

  Determines whether the produced artifacts should be published to the Gradle plugin portal. Plugin publishing is only applicable for open source projects that define the isOpenSource property with the value true. Plugin publishing is enabled when the Gradle plugin key and secret project properties are provided, and the project build number is not SNAPSHOT.

  Parameters:

  project - The project being configured

  Returns:

  True iff artifacts should be published to the plugin portal

• static boolean isProjectPropertySet(org.gradle.api.Project project, java.lang.String propertyName)

  Checks that the parameter property has a non-empty string that does not evaluate to false,or a non-empty collection value.

  Parameters:

  project - The project to check

  propertyName - The property name to check

• static boolean isShadowJarEnabled(org.gradle.api.Project project)

  Checks whether a shadow jar should be built. This is determined by the presence of the buildShadowJar project property, with a non-empty value.

  Parameters:

  project - The project to check

  Returns:

  True iff a shadow jar should be built, else false

• static void logProperties(org.gradle.api.Project project)

  Logs the required and derived project properties.

  Parameters:

  project - The project to configure

• static boolean shouldApplyPlugin(org.gradle.api.Project project, java.lang.String pluginId, java.util.Map<java.lang.String, groovy.lang.Closure<java.lang.Boolean>> pluginInclusion)

  Uses the pluginInclusion map to determine whether the plugin identified by the parameter identifier should be applied to the project.

  Parameters:

  project - The project being configured

  pluginId - The plugin identifier

  pluginInclusion - Optional closures to check plugin inclusion

  Returns:

  True iff the plugin should be applied to the project