Trim default Gradle build outputs

Author: 8Keep

.github/workflows/main.yml

@@ -138,7 +138,7 @@ jobs:
         uses: gradle/actions/wrapper-validation@v6.1.0
       - 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()
@@ -277,8 +277,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" ];
@@ -298,13 +297,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
 
@@ -483,6 +482,7 @@ jobs:
             -PsigningKey='${{ secrets.SIGNING_KEY }}' \
             -PsigningPassword='${{ secrets.SIGNING_PASSWORD }}' \
             -PuseCommitHashAsVersionName=true \
+            -PbuildJavaDoc=true \
             --console=plain --stacktrace
           fi
 
@@ -546,6 +546,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,7 +3,15 @@
 //
 
 apply plugin: 'java-library'
-apply plugin: 'groovy'
+group = 'org.jmonkeyengine'
+version = jmeFullVersion
+
+def groovySourcePresent = project.file('src/main/groovy').exists() || project.file('src/test/groovy').exists()
+
+if (groovySourcePresent) {
+    apply plugin: 'groovy'
+}
+
 apply plugin: 'maven-publish'
 apply plugin: 'signing'
 apply plugin: 'eclipse'
@@ -12,8 +20,6 @@ apply plugin: 'checkstyle'
 eclipse.jdt.file.withProperties { props ->
     props.setProperty "org.eclipse.jdt.core.circularClasspath", "warning"
 }
-group = 'org.jmonkeyengine'
-version = jmeFullVersion
 
 java {
     sourceCompatibility = JavaVersion.VERSION_1_8
@@ -24,7 +30,7 @@ java {
     }
 }
 
-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'
@@ -44,8 +50,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
@@ -67,7 +75,7 @@ jar {
     }
 }
 
-javadoc {
+tasks.named('javadoc', Javadoc) {
     failOnError = false
     options.memberLevel = org.gradle.external.javadoc.JavadocMemberLevel.PROTECTED
     options.docTitle = "jMonkeyEngine ${jmeFullVersion} ${project.name} Javadoc"
@@ -90,14 +98,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 = {
@@ -125,18 +137,16 @@ ext.pomConfig = {
     }
 }
 
-tasks.named('assemble') {
-    dependsOn sourcesJar
-    if (buildJavaDoc == "true") {
-        dependsOn javadocJar
-    }
-}
+def hasSigningKey = providers.gradleProperty('signingKey').isPresent()
+def publishedModuleName = "${project.name}-${jmeFullVersion}"
 
 publishing {
     publications {
         maven(MavenPublication) {
-            artifact javadocJar
             artifact sourcesJar
+            if (buildJavaDoc == "true") {
+                artifact javadocJar
+            }
             from components.java
             pom {
                 description = POM_DESCRIPTION
@@ -197,10 +207,12 @@ publishing {
     }
 }
 
-publishToMavenLocal.doLast {
-    println 'published ' + project.getName() + "-${jmeFullVersion} to mavenLocal"
+tasks.named('publishToMavenLocal') {
+    doLast {
+        println "published ${publishedModuleName} to mavenLocal"
+    }
 }
-task('install') {
+tasks.register('install') {
     dependsOn 'publishToMavenLocal'
 }
 
@@ -211,8 +223,8 @@ signing {
 
     sign publishing.publications.maven
 }
-tasks.withType(Sign) {
-    onlyIf { gradle.rootProject.hasProperty('signingKey') }
+tasks.withType(Sign).configureEach {
+    onlyIf { hasSigningKey }
 }
 
 def checkstyleSupported = JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_21)
@@ -230,7 +242,7 @@ checkstyleTest {
     source ='src/test/java'
 }
 
-tasks.withType(Checkstyle) {
+tasks.withType(Checkstyle).configureEach {
     enabled = checkstyleSupported
     reports {
         xml.required.set(false)

gradle.properties

@@ -12,15 +12,15 @@ useCommitHashAsVersionName = false
 # generated version.
 includeBranchInVersion = false
 
-# specify if JavaDoc should be built
-buildJavaDoc = true
-
-# Let Gradle fetch missing JDKs for toolchains automatically.
-org.gradle.java.installations.auto-download=true
-
-# specify if SDK and Native libraries get built
-buildNativeProjects = false
-buildAndroidExamples = false
+# specify if JavaDoc should be built
+buildJavaDoc = false
+
+# Let Gradle fetch missing JDKs for toolchains automatically.
+org.gradle.java.installations.auto-download=true
+
+# specify if SDK and Native libraries get built
+buildNativeProjects = false
+buildAndroidExamples = false
 
 # Forcefully ignore prebuilt libraries
 skipPrebuildLibraries=false

jme3-examples/build.gradle

@@ -1,10 +1,11 @@
-ext.mainClassName = 'jme3test.TestChooser'
+def examplesMainClassName = 'jme3test.TestChooser'
+ext.mainClassName = examplesMainClassName
 
 def androidProject = project(':jme3-android')
 def androidNativeProject = project(':jme3-android-native')
 
 task run(dependsOn: 'build', type:JavaExec) {
-    mainClass = mainClassName
+    mainClass = examplesMainClassName
     classpath = sourceSets.main.runtimeClasspath
 
     if (System.properties['java.util.logging.config.file'] != null) {
@@ -208,7 +209,7 @@ jar.doFirst{
 //                'Implementation-Title'   : appName,
 //                'Implementation-Version' : version,
 //                'Implementation-Vendor'  : vendor,
-                'Main-Class'             : getProperty('mainClassName'),
+                'Main-Class'             : examplesMainClassName,
                 // Add dependencies to manifest, remove version
                 'Class-Path'             : configurations.runtimeClasspath.resolvedConfiguration.resolvedArtifacts.collect {
                                                         'lib/' +