Add Convention Plugins for Java Modules

jjohannes · jjohannes · commit 52f132ba5c8f · 2025-07-23T23:58:09.000+02:00
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -44,3 +44,24 @@ jobs:
 #          projectName: "gradle-project-setup-howto"
 #          projectVersion: ${{ github.ref_name }}
 #          autoCreate: true
+
+  package:
+    needs: gradle-build
+    strategy:
+      matrix:
+        os: [ubuntu-22.04, windows-2022, macos-13, macos-14]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version-file: gradle/jdk-version.txt
+      - uses: gradle/actions/setup-gradle@v3
+        with:
+          cache-read-only: false
+      - run: "./gradlew assemble${{ matrix.os }}"
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Application Package ${{ matrix.os }}
+          path: app/build/packages/*/*
diff --git a/app/src/main/resourcesPackage/linux/icon.png b/app/src/main/resourcesPackage/linux/icon.png
diff --git a/app/src/main/resourcesPackage/macos/icon.icns b/app/src/main/resourcesPackage/macos/icon.icns
diff --git a/app/src/main/resourcesPackage/windows/icon.ico b/app/src/main/resourcesPackage/windows/icon.ico
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
diff --git a/gradle/modules.properties b/gradle/modules.properties
@@ -0,0 +1,3 @@
+# override defaults as there are multiple options
+jakarta.activation=com.sun.activation:jakarta.activation
+jakarta.mail=com.sun.mail:jakarta.mail
diff --git a/gradle/plugins/build.gradle.kts b/gradle/plugins/build.gradle.kts
@@ -8,6 +8,10 @@ dependencies {
     implementation("com.gradle:develocity-gradle-plugin:4.1")
     implementation("io.fuchs.gradle.classpath-collision-detector:classpath-collision-detector:1.0.0")
     implementation("org.cyclonedx:cyclonedx-gradle-plugin:2.3.1")
+    implementation("org.gradlex:extra-java-module-info:1.12")
+    implementation("org.gradlex:java-module-dependencies:1.8.1")
+    implementation("org.gradlex:java-module-packaging:1.0")
+    implementation("org.gradlex:java-module-testing:1.6")
     implementation("org.gradlex:jvm-dependency-conflict-resolution:2.4")
 }
 
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.base.identity.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.base.identity.gradle.kts
@@ -1,9 +1,5 @@
 plugins { id("org.gradle.base") }
 
-// Set the group required to refer to a Module "from outside".
-// I.e., when it is published or used in Included Builds.
-group = "org.example.product.java"
-
 // Set the version from 'version.txt'
 version = providers.fileContents(isolated.rootProject.projectDirectory.file("gradle/version.txt")).asText.getOrElse("")
 
@@ -16,5 +12,5 @@ if (providers.environmentVariable("CI").getOrElse("false").toBoolean()) {
             .asText
             .get()
             .trim()
-    version = "$version-$gitCommitTimestamp"
+    version = "$version.$gitCommitTimestamp"
 }
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.base.lifecycle.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.base.lifecycle.gradle.kts
@@ -11,13 +11,13 @@ if (gradle.startParameter.taskNames.isEmpty()) {
 tasks.register("qualityCheck") {
     group = "verification"
     description = "Runs checks (without executing tests)"
-    dependsOn(tasks.assemble)
+    dependsOn(tasks.withType<SourceTask>())
 }
 
 tasks.register("qualityGate") {
     group = "build"
     description = "Runs checks and auto-corrects (without executing tests)"
-    dependsOn(tasks.assemble)
+    dependsOn(tasks.withType<SourceTask>())
 }
 
 tasks.check { dependsOn(tasks.named("qualityCheck")) }
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.base.module-system-rules.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.base.module-system-rules.gradle.kts
@@ -0,0 +1,20 @@
+plugins { id("org.gradlex.extra-java-module-info") }
+
+extraJavaModuleInfo {
+    failOnAutomaticModules = true
+
+    module("com.github.virtuald:curvesapi", "com.github.virtuald.curvesapi")
+    module("com.google.code.findbugs:jsr305", "javax.annotations.jsr305")
+    module("com.google.errorprone:error_prone_annotations", "com.google.errorprone.annotations")
+    module("com.google.guava:failureaccess", "com.google.common.internal.failureaccess")
+    module("com.google.guava:guava", "com.google.common")
+    module("com.zaxxer:SparseBitSet", "SparseBitSet")
+    module("commons-codec:commons-codec", "org.apache.commons.codec")
+    module("commons-io:commons-io", "org.apache.commons.io")
+    module("org.apache.commons:commons-collections4", "org.apache.commons.collections4")
+    module("org.apache.commons:commons-compress", "org.apache.commons.compress")
+    module("org.apache.commons:commons-lang3", "org.apache.commons.lang3")
+    module("org.apache.commons:commons-math3", "commons.math3")
+    module("org.apache.velocity:velocity-engine-core", "velocity.engine.core")
+    module("org.hamcrest:hamcrest-core", "org.hamcrest.core")
+}
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.build.settings.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.build.settings.gradle.kts
@@ -1,13 +1,13 @@
+import org.gradlex.javamodule.dependencies.initialization.RootPluginsExtension
+
 plugins {
     id("org.example.gradle.report.develocity")
     id("org.example.gradle.feature.repositories")
     id("org.example.gradle.feature.build-cache")
     id("org.example.gradle.feature.project-structure")
 }
 
-gradle.lifecycle.beforeProject {
-    if (this.path == ":") {
-        apply(plugin = "org.example.gradle.base.lifecycle")
-        apply(plugin = "org.example.gradle.check.format-gradle.root")
-    }
+configure<RootPluginsExtension> {
+    id("org.example.gradle.base.lifecycle")
+    id("org.example.gradle.check.format-gradle.root")
 }
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.check.dependencies.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.check.dependencies.gradle.kts
@@ -1,5 +1,4 @@
-import com.autonomousapps.DependencyAnalysisSubExtension
-import com.autonomousapps.tasks.ProjectHealthTask
+import org.gradlex.javamodule.dependencies.tasks.ModuleDirectivesScopeCheck
 
 plugins {
     id("org.gradle.java")
@@ -8,15 +7,12 @@ plugins {
     id("org.example.gradle.base.lifecycle")
 }
 
-// Configure the dependency analysis plugin to fail if issues are found
-configure<DependencyAnalysisSubExtension> { issues { onAny { severity("fail") } } }
-
 tasks.named("qualityCheck") {
     dependsOn(tasks.detectCollisions)
-    dependsOn(tasks.withType<ProjectHealthTask>())
+    dependsOn(tasks.withType<ModuleDirectivesScopeCheck>())
 }
 
 tasks.named("qualityGate") {
     dependsOn(tasks.detectCollisions)
-    dependsOn(tasks.withType<ProjectHealthTask>())
+    dependsOn(tasks.withType<ModuleDirectivesScopeCheck>())
 }
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.check.format-gradle.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.check.format-gradle.gradle.kts
@@ -1,16 +1,9 @@
-import org.example.gradle.spotless.SortDependenciesStep
-
 plugins {
     id("com.diffplug.spotless")
     id("org.example.gradle.base.lifecycle")
 }
 
-spotless {
-    kotlinGradle {
-        ktfmt().kotlinlangStyle().configure { it.setMaxWidth(500) }
-        addStep(SortDependenciesStep.create())
-    }
-}
+spotless { kotlinGradle { ktfmt().kotlinlangStyle().configure { it.setMaxWidth(500) } } }
 
 tasks.named("qualityCheck") { dependsOn(tasks.spotlessCheck) }
 
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.check.format-java.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.check.format-java.gradle.kts
@@ -1,3 +1,5 @@
+import org.example.gradle.spotless.SortDependenciesStep
+
 plugins {
     id("com.diffplug.spotless")
     id("org.example.gradle.base.lifecycle")
@@ -9,6 +11,7 @@ spotless {
         removeUnusedImports()
         cleanthat()
         palantirJavaFormat()
+        addStep(SortDependenciesStep.create())
     }
 }
 
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.component.application.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.component.application.gradle.kts
@@ -1,6 +1,7 @@
 plugins {
     id("org.gradle.application")
     id("org.example.gradle.base.dependency-rules")
+    id("org.example.gradle.base.module-system-rules")
     id("org.example.gradle.base.identity")
     id("org.example.gradle.base.lifecycle")
     id("org.example.gradle.check.dependencies")
@@ -9,6 +10,7 @@ plugins {
     id("org.example.gradle.feature.checksum")
     id("org.example.gradle.feature.compile-java")
     id("org.example.gradle.feature.javadoc")
+    id("org.example.gradle.feature.jpackage")
     id("org.example.gradle.feature.test")
     id("org.example.gradle.feature.test-end-to-end")
     id("org.example.gradle.feature.war")
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.component.library.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.component.library.gradle.kts
@@ -1,12 +1,14 @@
 plugins {
     id("org.gradle.java-library")
     id("org.example.gradle.base.dependency-rules")
+    id("org.example.gradle.base.module-system-rules")
     id("org.example.gradle.base.identity")
     id("org.example.gradle.base.lifecycle")
     id("org.example.gradle.check.dependencies")
     id("org.example.gradle.check.format-gradle")
     id("org.example.gradle.check.format-java")
     id("org.example.gradle.feature.compile-java")
     id("org.example.gradle.feature.javadoc")
+    id("org.example.gradle.feature.jpackage")
     id("org.example.gradle.feature.test")
 }
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.feature.compile-java.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.feature.compile-java.gradle.kts
@@ -24,7 +24,7 @@ tasks.withType<JavaCompile>().configureEach {
         encoding = "UTF-8"
         compilerArgs.add("-implicit:none")
         compilerArgs.add("-Werror")
-        compilerArgs.add("-Xlint:all,-serial")
+        compilerArgs.add("-Xlint:all,-serial,-exports")
     }
 }
 
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.feature.jpackage.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.feature.jpackage.gradle.kts
@@ -0,0 +1,27 @@
+plugins { id("org.gradlex.java-module-packaging") }
+
+// Multi target support and packaging
+javaModulePackaging {
+    target("ubuntu-22.04") {
+        operatingSystem = OperatingSystemFamily.LINUX
+        architecture = MachineArchitecture.X86_64
+        packageTypes = listOf("deb")
+    }
+    target("macos-13") {
+        operatingSystem = OperatingSystemFamily.MACOS
+        architecture = MachineArchitecture.X86_64
+        packageTypes = listOf("dmg")
+    }
+    target("macos-14") {
+        operatingSystem = OperatingSystemFamily.MACOS
+        architecture = MachineArchitecture.ARM64
+        packageTypes = listOf("dmg")
+    }
+    target("windows-2022") {
+        operatingSystem = OperatingSystemFamily.WINDOWS
+        architecture = MachineArchitecture.X86_64
+        packageTypes = listOf("exe")
+    }
+
+    primaryTarget(target("macos-14"))
+}
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.feature.project-structure.settings.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.feature.project-structure.settings.gradle.kts
@@ -1,18 +1,18 @@
-// Include all subfolders that contain a 'build.gradle.kts' as subprojects
-rootDir
-    .listFiles()
-    ?.filter { File(it, "build.gradle.kts").exists() }
-    ?.forEach { subproject -> include(subproject.name) }
+import org.gradlex.javamodule.dependencies.initialization.JavaModulesExtension
 
-// Platform project
-include(":versions")
+plugins { id("org.gradlex.java-module-dependencies") }
 
-project(":versions").projectDir = file("gradle/versions")
+configure<JavaModulesExtension> {
+    directory(".") {
+        // Set the group required to refer to a Module "from outside".
+        // I.e., when it is published or used in Included Builds.
+        group = "org.example.product.javamodules"
+    }
+    versions("gradle/versions")
 
-// Aggregation and analysis project to create reports about the whole software (coverage, SBOM, ...)
-include(":aggregation")
-
-project(":aggregation").projectDir = file("gradle/aggregation")
+    // Analysis project to create reports about the whole software (coverage, SBOM, ...)
+    module("gradle/aggregation")
+}
 
 // Allow local projects to be referred to by accessor
 enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.feature.test.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.feature.test.gradle.kts
@@ -1,6 +1,7 @@
 plugins {
     id("org.gradle.jacoco") // Record test coverage data during test execution
     id("org.gradle.java")
+    id("org.gradlex.java-module-testing")
 }
 
 testing.suites.named<JvmTestSuite>("test") {
diff --git a/gradle/plugins/src/main/kotlin/org.example.gradle.feature.use-all-catalog-versions.gradle.kts b/gradle/plugins/src/main/kotlin/org.example.gradle.feature.use-all-catalog-versions.gradle.kts
diff --git a/gradle/plugins/src/main/kotlin/org/example/gradle/spotless/SortDependenciesStep.kt b/gradle/plugins/src/main/kotlin/org/example/gradle/spotless/SortDependenciesStep.kt
diff --git a/gradle/plugins/src/test/kotlin/org/example/gradle/test/ConventionPluginTest.kt b/gradle/plugins/src/test/kotlin/org/example/gradle/test/ConventionPluginTest.kt
diff --git a/gradle/versions/build.gradle.kts b/gradle/versions/build.gradle.kts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# override defaults as there are multiple options`
	`2`	`+jakarta.activation=com.sun.activation:jakarta.activation`
	`3`	`+jakarta.mail=com.sun.mail:jakarta.mail`
Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,13 @@ if (gradle.startParameter.taskNames.isEmpty()) {`
`11`	`11`	`tasks.register("qualityCheck") {`
`12`	`12`	`group = "verification"`
`13`	`13`	`description = "Runs checks (without executing tests)"`
`14`		`- dependsOn(tasks.assemble)`
	`14`	`+ dependsOn(tasks.withType<SourceTask>())`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`tasks.register("qualityGate") {`
`18`	`18`	`group = "build"`
`19`	`19`	`description = "Runs checks and auto-corrects (without executing tests)"`
`20`		`- dependsOn(tasks.assemble)`
	`20`	`+ dependsOn(tasks.withType<SourceTask>())`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`tasks.check { dependsOn(tasks.named("qualityCheck")) }`