Trim default Gradle build outputs

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`

common.gradle

@@ -3,24 +3,52 @@
 //
 
 apply plugin: 'java-library'
-apply plugin: 'groovy'
-apply plugin: 'maven-publish'
-apply plugin: 'signing'
-apply plugin: 'eclipse'
-apply plugin: 'checkstyle'
-
-eclipse.jdt.file.withProperties { props ->
-    props.setProperty "org.eclipse.jdt.core.circularClasspath", "warning"
-}
 group = 'org.jmonkeyengine'
 version = jmeFullVersion
 
+def requestedTasks = gradle.startParameter.taskNames
+def taskRequested = { String taskName ->
+    requestedTasks.any { requested ->
+        requested == taskName || requested.endsWith(":${taskName}")
+    }
+}
+def taskNameContains = { String fragment ->
+    requestedTasks.any { requested ->
+        requested.toLowerCase(Locale.ROOT).contains(fragment.toLowerCase(Locale.ROOT))
+    }
+}
+def publishRequested = taskNameContains('publish') || taskRequested('install')
+def checkstyleRequested = taskNameContains('checkstyle')
+def eclipseRequested = taskNameContains('eclipse')
+def groovySourcePresent = project.name == 'jme3-core'
+
+if (groovySourcePresent) {
+    apply plugin: 'groovy'
+}
+
+if (publishRequested) {
+    apply plugin: 'maven-publish'
+    apply plugin: 'signing'
+}
+
+if (eclipseRequested) {
+    apply plugin: 'eclipse'
+
+    eclipse.jdt.file.withProperties { props ->
+        props.setProperty "org.eclipse.jdt.core.circularClasspath", "warning"
+    }
+}
+
+if (checkstyleRequested) {
+    apply plugin: 'checkstyle'
+}
+
 java {
     sourceCompatibility = JavaVersion.VERSION_1_8
     targetCompatibility = JavaVersion.VERSION_1_8
 }
 
-tasks.withType(JavaCompile) { // compile-time options:
+tasks.withType(JavaCompile).configureEach { // compile-time options:
     //options.compilerArgs << '-Xlint:deprecation' // to show deprecation warnings
     options.compilerArgs << '-Xlint:unchecked'
     options.encoding = 'UTF-8'
@@ -42,8 +70,10 @@ dependencies {
     testImplementation libs.junit.jupiter
     testImplementation libs.mokito.core
     testImplementation libs.mokito.junit.jupiter
-    testImplementation libs.groovy.test
     testRuntimeOnly libs.junit.platform.launcher
+    if (groovySourcePresent) {
+        testImplementation libs.groovy.test
+    }
 }
 
 // Uncomment if you want to see the status of every test that is run and
@@ -65,7 +95,7 @@ jar {
     }
 }
 
-javadoc {
+tasks.named('javadoc', Javadoc) {
     failOnError = false
     options.memberLevel = org.gradle.external.javadoc.JavadocMemberLevel.PROTECTED
     options.docTitle = "jMonkeyEngine ${jmeFullVersion} ${project.name} Javadoc"
@@ -88,14 +118,18 @@ test {
     }
 }
 
-task sourcesJar(type: Jar, dependsOn: classes, description: 'Creates a jar from the source files.') {
+def sourcesJar = tasks.register('sourcesJar', Jar) {
+    dependsOn classes
+    description = 'Creates a jar from the source files.'
     archiveClassifier = 'sources'
     from sourceSets*.allSource
 }
 
-task javadocJar(type: Jar, dependsOn: javadoc, description: 'Creates a jar from the javadoc files.') {
+def javadocJar = tasks.register('javadocJar', Jar) {
+    dependsOn javadoc
+    description = 'Creates a jar from the javadoc files.'
     archiveClassifier = 'javadoc'
-    from javadoc.destinationDir
+    from tasks.named('javadoc', Javadoc).map { it.destinationDir }
 }
 
 ext.pomConfig = {
@@ -123,116 +157,120 @@ ext.pomConfig = {
     }
 }
 
-tasks.named('assemble') {
-    dependsOn sourcesJar
-    if (buildJavaDoc == "true") {
-        dependsOn javadocJar
-    }
-}
+if (publishRequested) {
+    def hasSigningKey = providers.gradleProperty('signingKey').isPresent()
+    def publishedModuleName = "${project.name}-${jmeFullVersion}"
 
-publishing {
-    publications {
-        maven(MavenPublication) {
-            artifact javadocJar
-            artifact sourcesJar
-            from components.java
-            pom {
-                description = POM_DESCRIPTION
-                developers {
-                    developer {
-                        id = 'jMonkeyEngine'
-                        name = 'jMonkeyEngine Team'
-                    }
+    publishing {
+        publications {
+            maven(MavenPublication) {
+                artifact sourcesJar
+                if (buildJavaDoc == "true") {
+                    artifact javadocJar
                 }
-                inceptionYear = POM_INCEPTION_YEAR
-                licenses {
-                    license {
-                        distribution = POM_LICENSE_DISTRIBUTION
-                        name = POM_LICENSE_NAME
-                        url = POM_LICENSE_URL
+                from components.java
+                pom {
+                    description = POM_DESCRIPTION
+                    developers {
+                        developer {
+                            id = 'jMonkeyEngine'
+                            name = 'jMonkeyEngine Team'
+                        }
                     }
+                    inceptionYear = POM_INCEPTION_YEAR
+                    licenses {
+                        license {
+                            distribution = POM_LICENSE_DISTRIBUTION
+                            name = POM_LICENSE_NAME
+                            url = POM_LICENSE_URL
+                        }
+                    }
+                    name = POM_NAME
+                    scm {
+                        connection = POM_SCM_CONNECTION
+                        developerConnection = POM_SCM_DEVELOPER_CONNECTION
+                        url = POM_SCM_URL
+                    }
+                    url = POM_URL
                 }
-                name = POM_NAME
-                scm {
-                    connection = POM_SCM_CONNECTION
-                    developerConnection = POM_SCM_DEVELOPER_CONNECTION
-                    url = POM_SCM_URL
-                }
-                url = POM_URL
+                version = project.version
             }
-            version = project.version
         }
-    }
 
-    repositories {
-        maven {
-            name = 'Dist'
-            url = gradle.rootProject.projectDir.absolutePath + '/dist/maven'
-        }
+        repositories {
+            maven {
+                name = 'Dist'
+                url = gradle.rootProject.projectDir.absolutePath + '/dist/maven'
+            }
 
-        // Uploading to Sonatype relies on the existence of 2 properties
-        // (centralUsername and centralPassword)
-        // which should be set using -P options on the command line.
+            // Uploading to Sonatype relies on the existence of 2 properties
+            // (centralUsername and centralPassword)
+            // which should be set using -P options on the command line.
 
-        maven {
-            // for uploading release builds to the default repo in Sonatype's OSSRH staging area
-            credentials {
-                username = gradle.rootProject.hasProperty('centralUsername') ? centralUsername : 'Unknown user'
-                password = gradle.rootProject.hasProperty('centralPassword') ? centralPassword : 'Unknown password'
+            maven {
+                // for uploading release builds to the default repo in Sonatype's OSSRH staging area
+                credentials {
+                    username = gradle.rootProject.hasProperty('centralUsername') ? centralUsername : 'Unknown user'
+                    password = gradle.rootProject.hasProperty('centralPassword') ? centralPassword : 'Unknown password'
+                }
+                name = 'Central'
+                url = 'https://ossrh-staging-api.central.sonatype.com/service/local/staging/deploy/maven2/'
             }
-            name = 'Central'
-            url = 'https://ossrh-staging-api.central.sonatype.com/service/local/staging/deploy/maven2/'
-        }
-        maven {
-            // for uploading snapshot builds to Sonatype's maven-snapshots repo
-            credentials {
-                username = gradle.rootProject.hasProperty('centralUsername') ? centralUsername : 'Unknown user'
-                password = gradle.rootProject.hasProperty('centralPassword') ? centralPassword : 'Unknown password'
+            maven {
+                // for uploading snapshot builds to Sonatype's maven-snapshots repo
+                credentials {
+                    username = gradle.rootProject.hasProperty('centralUsername') ? centralUsername : 'Unknown user'
+                    password = gradle.rootProject.hasProperty('centralPassword') ? centralPassword : 'Unknown password'
+                }
+                name = 'SNAPSHOT'
+                url = 'https://central.sonatype.com/repository/maven-snapshots/'
             }
-            name = 'SNAPSHOT'
-            url = 'https://central.sonatype.com/repository/maven-snapshots/'
         }
     }
-}
 
-publishToMavenLocal.doLast {
-    println 'published ' + project.getName() + "-${jmeFullVersion} to mavenLocal"
-}
-task('install') {
-    dependsOn 'publishToMavenLocal'
-}
+    tasks.named('publishToMavenLocal') {
+        doLast {
+            println "published ${publishedModuleName} to mavenLocal"
+        }
+    }
+    tasks.register('install') {
+        dependsOn 'publishToMavenLocal'
+    }
 
-signing {
-    def signingKey = gradle.rootProject.findProperty('signingKey')
-    def signingPassword = gradle.rootProject.findProperty('signingPassword')
-    useInMemoryPgpKeys(signingKey, signingPassword)
+    signing {
+        def signingKey = gradle.rootProject.findProperty('signingKey')
+        def signingPassword = gradle.rootProject.findProperty('signingPassword')
+        useInMemoryPgpKeys(signingKey, signingPassword)
 
-    sign publishing.publications.maven
-}
-tasks.withType(Sign) {
-    onlyIf { gradle.rootProject.hasProperty('signingKey') }
+        sign publishing.publications.maven
+    }
+    tasks.withType(Sign).configureEach {
+        onlyIf { hasSigningKey }
+    }
 }
 
-def checkstyleSupported = JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_21)
+if (checkstyleRequested) {
+    def checkstyleSupported = JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_21)
 
-checkstyle {
-    toolVersion = libs.versions.checkstyle.get()
-    configFile = file("${gradle.rootProject.rootDir}/config/checkstyle/checkstyle.xml")
-}
+    checkstyle {
+        toolVersion = libs.versions.checkstyle.get()
+        configFile = file("${gradle.rootProject.rootDir}/config/checkstyle/checkstyle.xml")
+    }
 
-checkstyleMain {
-    source ='src/main/java'
-}
+    checkstyleMain {
+        source ='src/main/java'
+    }
 
-checkstyleTest {
-    source ='src/test/java'
-}
+    checkstyleTest {
+        source ='src/test/java'
+    }
 
-tasks.withType(Checkstyle) {
-    enabled = checkstyleSupported
-    reports {
-        xml.required.set(false)
-        html.required.set(true)
+    tasks.withType(Checkstyle).configureEach {
+        enabled = checkstyleSupported
+        reports {
+            xml.required.set(false)
+            html.required.set(true)
+        }
+        include("**/com/jme3/renderer/**/*.java")
     }
-    include("**/com/jme3/renderer/**/*.java")
 }