kordamp / kordamp-gradle-plugins

A collection of Gradle plugins

kordamp-gradle-plugins

---

A set of opinionated Gradle plugins that provide common behavior observed in Maven, and more!

Usage

Option #1

buildscript {
    repositories {
        gradlePluginPortal()
        mavenCentral()
    }
    dependencies {
        classpath 'org.kordamp.gradle:<plugin-artifact-id>:0.54.0'
    }
}
apply plugin: '<plugin-id>'

Option #2

plugins {
    id '<plugin-id>' version '0.54.0'
}

Where <plugin-id> stands for any of the ids described in the guide. Most times it’s enough to simply apply the org.kordamp.gradle.project at the root. All plugins may be applied independently as well.

Refer to the guide for further information on configuration and usage.

Requirements

• Java 11

• Gradle 7+

kordamp-gradle-plugins's Issues

Support Xref reports

Integrate https://maven.apache.org/jxr/index.html.

Sadly it only works for Java sources only at the moment (version 3.0.0).

Create a guide project

SourceHtml plugin fails with projects that do not have /src/main/java directory

Error parsing SourceXref.javaVersion

Add a task to calculate the effective settings

Verify asciidoctor.attributes before overriding their values

GroovydocJar task should be a dependency of 'assemble' task

[Guide] Allow attribute values to be overriden in a document

Requires appending @ at the end of the attribute name

Let 'maven' be the defualt value for bintray.repo

[Base] Add a task that displays applied plugins

Do not use evaluationDependsOnChildren()

Fix aggregate source stats generation

Missing documentation on config.release flag

See #47

Groovydoc should include all Java sources

Source places under src/main/java (typically equivalent to project.sourceSets.main.java.srcDirs should be part of the generated Groovydoc.

Disable bintray tasks if config.bintray.enabled is false

[BuildInfo] Add options to skip calculation of some properties

Support generation of Kotlin docs

Use https://github.com/Kotlin/dokka

AggregateJavadocs task can't handle module-info.java

Provide Gradle Kotlin DSL examples in documentation

As explained at gradle/gradle#6790; follow tabbed alternative shown by @bmuschko at bmuschko/gradle-docker-plugin#677

Support <timezone> and <properties> blocks for Developer/Contributor

JavadocJar task should be a dependency of 'assemble' task

Add a source-html plugin

Based on https://github.com/bmuschko/gradle-java2html-plugin/

[Base] Suppor the SCM block in POM files

GuidePlugin should copy the aggregate source HTML report

[Bintray] Add option to skip auto-sync with Maven Central

[Jar] Value for buildJdk is missing

SourceJar task should be a dependency of 'assemble' task

Do not configure tasks per SourceSet

Add common license aliases

[License] Allow non FLOSS licenses to be specified

Project plugin does not propagate to children

One must apply the org.kordamp.gradle.project manually to all projects.

[Publishing] Configure artifact signing

Add a source-stats plugin

Based on https://github.com/aalmiray/stats-gradle-plugin

Missing license name in generated POM

When evaluating licenses with an id property, no value for <name> is set in the POM.

Make xml and txt formats default for config.stats

Let license aliases to be defined using the DSL

[Publishing] Allow posting publications to release/snapshot repositories

SourceStats task is not available on root project when there are no children

Move every plugin to its own package

Currently all plugins reside in the org.kordamp.gradle package.

Split project plugin for closed and open source usages

The org.kordamp.gradle.project plugin includes the org.kordamp.gradle.bintray plugin by default, assuming artifacts will be pushed to Bintray. Also license checks are expected to follow an SPDX license (see #42)

License information is missing

In the context of a multi project build, license information is not properly propagated from root to child project.

[Bintray] Plugin is disabled by defualt on subprojects

Aggregate dependency-license report doesn't handle multiple licenses per dependency

Add a plugin for BOM file generation

Values from config are eagerly applied

Affected entries are

• bintray.repo
• bintray.name
• bintray.githubRepo
• license.name
• license.url
• info.name
• info.vendor
• info.inceptionYear

Consider making the build reproducible by default

Your blog post [1] says

All JARs have their manifest enriched with additional entries such as build date/time/revision and more

I'd like to point out that adding clock time makes the build non-reproducible over time - i.e. the same source tree built at two occasions will produce binarily different artifacts.

I see that having some date in manifest is practical. You may want to take the date of the last commit instead of the clock time.

Of course, this is not the only issue breaking the build reproducibility. The ZIP entry timestamps in JARs, WARs, etc. is another important one. Not sure how you handle those. Anyway, build reproducibility is goal worthwhile for making the defaults compatible with it.

[1] http://andresalmiray.com/the-gradle-pom/

[BuildInfo] Allow buildTime to be set to 0

Add an aggregate license report

[Base] Add a task that displays configured repositories

Disable license tasks if license.enabled is set to false

Disable LicenseCheck and LicenseFormat tasks.