Speed up Gradle 9 builds

Author: 8Keep

.github/workflows/main.yml

@@ -138,7 +138,7 @@ jobs:
         uses: gradle/actions/wrapper-validation@v5.0.2
       - name: Test with Gradle Wrapper
         run: |
-          ./gradlew :jme3-screenshot-test:screenshotTest
+          ./gradlew :jme3-screenshot-tests:screenshotTest
       - name: Upload Test Reports
         uses: actions/upload-artifact@v7.0.0
         if: always()
@@ -285,8 +285,7 @@ jobs:
         shell: bash
         run: |
           # Normal build plus ZIP distribution and merged javadoc
-          ./gradlew -PuseCommitHashAsVersionName=true -PskipPrebuildLibraries=true \
-          -x checkstyleMain -x checkstyleTest \
+          ./gradlew -PuseCommitHashAsVersionName=true -PskipPrebuildLibraries=true -PbuildJavaDoc=true \
           build createZipDistribution mergedJavadoc
 
           if [ "${{ matrix.deploy }}" = "true" ];
@@ -306,13 +305,13 @@ jobs:
               echo "SIGNING_KEY, SIGNING_PASSWORD"
 
               ./gradlew publishMavenPublicationToDistRepository \
-              -PskipPrebuildLibraries=true -PuseCommitHashAsVersionName=true \
+              -PskipPrebuildLibraries=true -PuseCommitHashAsVersionName=true -PbuildJavaDoc=true \
               --console=plain --stacktrace
             else
               ./gradlew publishMavenPublicationToDistRepository \
               -PsigningKey='${{ secrets.SIGNING_KEY }}' \
               -PsigningPassword='${{ secrets.SIGNING_PASSWORD }}' \
-              -PskipPrebuildLibraries=true -PuseCommitHashAsVersionName=true \
+              -PskipPrebuildLibraries=true -PuseCommitHashAsVersionName=true -PbuildJavaDoc=true \
               --console=plain --stacktrace
             fi
 
@@ -491,6 +490,7 @@ jobs:
             -PsigningKey='${{ secrets.SIGNING_KEY }}' \
             -PsigningPassword='${{ secrets.SIGNING_PASSWORD }}' \
             -PuseCommitHashAsVersionName=true \
+            -PbuildJavaDoc=true \
             --console=plain --stacktrace
           fi
 
@@ -554,6 +554,7 @@ jobs:
               -PsigningKey='${{ secrets.SIGNING_KEY }}' \
               -PsigningPassword='${{ secrets.SIGNING_PASSWORD }}' \
               -PuseCommitHashAsVersionName=true \
+              -PbuildJavaDoc=true \
               --console=plain --stacktrace
             .github/actions/tools/uploadToCentral.sh \
               -p '${{ secrets.CENTRAL_PASSWORD }}' \

CONTRIBUTING.md

@@ -139,12 +139,14 @@ Run the Gradle wrapper:
 
 After a successful build,
 snapshot jars will be found in the "*/build/libs" subfolders.
+The default build skips JavaDoc and source archives for speed; release and
+publishing tasks build them explicitly.
 
 ### Related Gradle tasks
 
 You can install the Maven artifacts to your local repository:
- + using Bash or PowerShell:  `./gradlew install`
- + using Windows Command Prompt:  `.\gradlew install`
+ + using Bash or PowerShell:  `./gradlew -PbuildJavaDoc=true install`
+ + using Windows Command Prompt:  `.\gradlew -PbuildJavaDoc=true install`
 
 You can restore the project to a pristine state:
  + using Bash or PowerShell: `./gradlew clean`

README.md

@@ -97,10 +97,12 @@ Read our [contribution guide](https://github.com/jMonkeyEngine/jmonkeyengine/blo
 
 After a successful build,
 fresh JARs will be found in "*/build/libs".
+The default build skips JavaDoc and source archives for speed; release and
+publishing tasks build them explicitly.
 
 You can install the JARs to your local Maven repository:
-+ using Bash or Fish or PowerShell or Zsh: `./gradlew install`
-+ using Windows Command Prompt: `.\gradlew install`
++ using Bash or Fish or PowerShell or Zsh: `./gradlew -PbuildJavaDoc=true install`
++ using Windows Command Prompt: `.\gradlew -PbuildJavaDoc=true install`
 
 You can run the "jme3-examples" app:
 + using Bash or Fish or PowerShell or Zsh: `./gradlew run`

build.gradle

@@ -13,6 +13,8 @@ buildscript {
 }
 
 import org.gradle.api.file.RelativePath
+import java.nio.file.Files
+import java.nio.file.StandardCopyOption
 
 // Set the license for IDEs that understand this
 ext.license = file("$rootDir/source-file-header-template.txt")
@@ -25,7 +27,7 @@ allprojects {
         mavenCentral()
         google()
     }
-    tasks.withType(Jar) {
+    tasks.withType(Jar).configureEach {
         duplicatesStrategy = 'include'
     }
 }
@@ -47,7 +49,7 @@ subprojects {
             toolVersion = libs.versions.spotbugs.get()
         }
 
-        tasks.withType(com.github.spotbugs.snom.SpotBugsTask ) {
+        tasks.withType(com.github.spotbugs.snom.SpotBugsTask).configureEach {
             reports {
                 html.required = !project.hasProperty("xml-reports")
                 xml.required = project.hasProperty("xml-reports")
@@ -63,39 +65,57 @@ tasks.register('run') {
 
 defaultTasks 'run'
 
+def fileSystemOperations = services.get(FileSystemOperations)
+def libDistDir = layout.buildDirectory.dir('libDist')
+def libDistArchives = subprojects.collectMany { subproject ->
+    if (subproject.hasProperty('mainClassName')) {
+        return []
+    }
+    subproject.tasks.withType(Jar).matching { task ->
+        task.name == 'jar' ||
+                task.name == 'sourcesJar' ||
+                (buildJavaDoc == "true" && task.name == 'javadocJar')
+    }.collect { archiveTask ->
+        [
+                projectName: subproject.name,
+                archiveFile: archiveTask.archiveFile,
+                archiveClassifier: archiveTask.archiveClassifier,
+                archiveExtension: archiveTask.archiveExtension,
+        ]
+    }
+}
+
 def libDist = tasks.register('libDist') {
-    dependsOn(subprojects.collect { it.tasks.named('build') })
+    dependsOn(libDistArchives.collect { it.archiveFile })
     description = 'Builds and copies the engine binaries, sources and javadoc to build/libDist'
+    inputs.files(libDistArchives.collect { it.archiveFile })
+    outputs.dir(libDistDir)
 
     doLast {
-        File libFolder = mkdir("$buildDir/libDist/lib")
-        File sourceFolder = mkdir("$buildDir/libDist/sources")
-        File javadocFolder = mkdir("$buildDir/libDist/javadoc")
-        subprojects.each {project ->
-            if(!project.hasProperty('mainClassName')){
-                project.tasks.withType(Jar).each {archiveTask ->
-                    String classifier = archiveTask.archiveClassifier.get()
-                    String ext = archiveTask.archiveExtension.get()
-                    File archiveFile = archiveTask.archiveFile.get().asFile
-                    if (classifier == "sources") {
-                        copy {
-                            from archiveFile
-                                into sourceFolder
-                                rename {project.name + '-' + classifier + '.' + ext}
-                        }
-                    } else if (classifier == "javadoc") {
-                        copy {
-                            from archiveFile
-                                into javadocFolder
-                                rename {project.name + '-' + classifier + '.' + ext}
-                        }
-                    } else{
-                        copy {
-                            from archiveFile
-                                into libFolder
-                                rename {project.name + '.' + ext}
-                        }
-                    }
+        File libFolder = libDistDir.get().dir('lib').asFile
+        File sourceFolder = libDistDir.get().dir('sources').asFile
+        File javadocFolder = libDistDir.get().dir('javadoc').asFile
+        libDistArchives.each { archive ->
+            String classifier = archive.archiveClassifier.get()
+            String ext = archive.archiveExtension.get()
+            File archiveFile = archive.archiveFile.get().asFile
+            if (classifier == "sources") {
+                fileSystemOperations.copy {
+                    from archiveFile
+                        into sourceFolder
+                        rename {archive.projectName + '-' + classifier + '.' + ext}
+                }
+            } else if (classifier == "javadoc") {
+                fileSystemOperations.copy {
+                    from archiveFile
+                        into javadocFolder
+                        rename {archive.projectName + '-' + classifier + '.' + ext}
+                }
+            } else{
+                fileSystemOperations.copy {
+                    from archiveFile
+                        into libFolder
+                        rename {archive.projectName + '.' + ext}
                 }
             }
         }
@@ -146,6 +166,7 @@ def mergedJavadocSubprojects = [
         ":jme3-terrain",
 ]
 tasks.register('mergedJavadoc', Javadoc) {
+    dependsOn mergedJavadocSubprojects.collect { project(it).tasks.named('classes') }
     description = 'Creates Javadoc from all the projects.'
     title = 'jMonkeyEngine3'
     destinationDir = file("dist/javadoc")
@@ -157,7 +178,7 @@ tasks.register('mergedJavadoc', Javadoc) {
 
     options.overview = file("javadoc-overview.html")
     source = mergedJavadocSubprojects.collect { project(it).sourceSets.main.allJava }
-    classpath = files(mergedJavadocSubprojects.collect { project(it).sourceSets.main.compileClasspath })
+    classpath = files(mergedJavadocSubprojects.collect { project(it).sourceSets.main.compileClasspath.files })
 }
 
 def cleanMergedJavadoc = tasks.register('cleanMergedJavadoc', Delete) {
@@ -197,45 +218,40 @@ gradle.rootProject.ext.set("usePrebuildNatives", buildNativeProjects!="true");
 
 if (skipPrebuildLibraries != "true" && buildNativeProjects != "true") {
     File nativesSnapshotPropF = file('natives-snapshot.properties')
+    String prebuildNativesUrlTemplate = PREBUILD_NATIVES_URL
 
     if (nativesSnapshotPropF.exists()) {
-        def readNativesConfig = {
-            Properties nativesSnapshotProp = new Properties()
-            nativesSnapshotPropF.withInputStream { nativesSnapshotProp.load(it) }
-
-            String nativesSnapshot = nativesSnapshotProp.getProperty("natives.snapshot")
-            if (!nativesSnapshot) {
-                throw new GradleException("Missing 'natives.snapshot' in ${nativesSnapshotPropF}")
-            }
+        Properties nativesSnapshotProp = new Properties()
+        nativesSnapshotPropF.withInputStream { nativesSnapshotProp.load(it) }
 
-            [
-                snapshot: nativesSnapshot,
-                url: PREBUILD_NATIVES_URL.replace('${natives.snapshot}', nativesSnapshot),
-                zipFile: layout.buildDirectory.file("${nativesSnapshot}-natives.zip"),
-                nativeDir: layout.buildDirectory.dir("native"),
-            ]
+        String nativesSnapshot = nativesSnapshotProp.getProperty("natives.snapshot")
+        if (!nativesSnapshot) {
+            throw new GradleException("Missing 'natives.snapshot' in ${nativesSnapshotPropF}")
         }
 
-        def nativesZipFile = providers.provider { readNativesConfig().zipFile.get().asFile }
+        String nativesUrl = prebuildNativesUrlTemplate.replace('${natives.snapshot}', nativesSnapshot)
+        File nativesZipFile = layout.buildDirectory.file("${nativesSnapshot}-natives.zip").get().asFile
         def nativesPath = layout.buildDirectory.dir("native")
 
         def getNativesZipFile = tasks.register('getNativesZipFile') {
+            inputs.property('nativesUrl', nativesUrl)
             outputs.file(nativesZipFile)
             doFirst {
-                def nativesConfig = readNativesConfig()
-                File target = nativesConfig.zipFile.get().asFile
-                println("Use natives snapshot: ${nativesConfig.url}")
-                println("Download natives from ${nativesConfig.url} to ${target}")
-                target.getParentFile().mkdirs()
-                ant.get(src: nativesConfig.url, dest: target)
+                println("Use natives snapshot: ${nativesUrl}")
+                println("Download natives from ${nativesUrl} to ${nativesZipFile}")
+                nativesZipFile.getParentFile().mkdirs()
+                File tempFile = new File(nativesZipFile.parentFile, "${nativesZipFile.name}.part")
+                tempFile.delete()
+                ant.get(src: nativesUrl, dest: tempFile)
+                Files.move(tempFile.toPath(), nativesZipFile.toPath(), StandardCopyOption.REPLACE_EXISTING)
             }
         }
 
         def extractPrebuiltNatives = tasks.register('extractPrebuiltNatives', Sync) {
             dependsOn(getNativesZipFile)
             into(nativesPath)
             from({
-                zipTree(readNativesConfig().zipFile.get().asFile)
+                zipTree(nativesZipFile)
             }) {
                 eachFile { details ->
                     def segments = details.relativePath.segments