Remove annoyances, fix remaining compatibility issues (#25)

Remaining incompatibilites (won't be fixed)
- Dependence on Java 17

Buildscript changes
- Updated Gradle to 8.14
- Removed `buildSrc`
- GradleUtils is now built against a redistributed Gradle API 7.3
  dependency
- Updated the Shadow plugin to 9.0.0-beta13
- Force Gradle daemon's JVM version to 17 to fix issues with Groovydoc
  task

Code changes
- Yet another big cleanup
- Removed PromoteArtifact task (was marked as experimental, will be
  re-added in 3.0)
- Updated Git Version
- Removed annoyances within PomUtils
- Restored backwards compatibility with Gradle 7.3

Author: Jonathing

README.md

@@ -0,0 +1,21 @@
+# GradleUtils
+
+GradleUtils is a convention plugin for Minecraft Forge. It is a set of utilities commonly used by our projects which
+helps us standardize our buildscripts.
+
+## Compatibility
+
+<!-- TODO [GradleUtils][Compatibility] If possible, make a precise compatibility matrix. -->
+
+| GradleUtils    | Java | Gradle |
+|----------------|------|--------|
+| 2.0.x          | 8    | 7.2*   |
+| 2.1.0 - 2.3.0  | 8    | 8.4*   |
+| 2.3.1 - 2.3.3  | 11   | 8.4*   |
+| 2.3.4 - 2.3.6  | 11   | 8.5*   |
+| 2.4.0 - 2.4.9  | 17   | 8.6    |
+| 2.4.10 - 2.5.x | 17   | 8.1*   |
+| 2.6.x          | 17   | 7.3    |
+
+\*Compatibility was not tested for this version, but this is the lowest recommended version as it was built
+against it.

build.gradle

@@ -1,15 +1,14 @@
 import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 
 plugins {
-    id 'java-gradle-plugin'
-    id 'groovy'
+    id 'dev.gradleplugins.groovy-gradle-plugin'
     id 'idea'
     id 'eclipse'
     id 'maven-publish'
-    id 'net.minecraftforge.licenser' version '1.1.1'
-    id 'net.minecraftforge.gradleutils'
-    id 'com.gradle.plugin-publish' version '1.3.1'
-    id 'com.gradleup.shadow' version '8.3.6'
+    alias libs.plugins.licenser
+    alias libs.plugins.gradleutils
+    alias libs.plugins.plugin.publish
+    alias libs.plugins.shadow
 }
 
 final projectDisplayName = 'Forge Gradle Utilities'
@@ -19,33 +18,63 @@ version = gitversion.tagOffset
 
 println "Version: $version"
 
-apply from: 'build_shared.gradle'
+// Git Version requires Java 17
+java.toolchain.languageVersion = JavaLanguageVersion.of 17
+
+configurations {
+    named(JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME) {
+        // Fixes a conflict between Git Version's shadowed SLF4J from JGit and Gradle's own loggers
+        exclude group: 'org.slf4j', module: 'slf4j-api'
+    }
+}
+
+repositories {
+    maven { url = 'https://maven.minecraftforge.net' }
+    mavenCentral()
+}
+
+dependencies {
+    // Static Analysis
+    compileOnly libs.nulls
+
+    // GitHub Actions Workflows
+    implementation libs.yaml
+
+    // Git Version
+    implementation libs.gitver
+
+    // Backwards compatibility
+    implementation libs.jgit
+}
+
+// Removes local Gradle API from compileOnly. This is a workaround for bugged plugins.
+// TODO [GradleUtils][GradleAPI] Remove this once they are fixed.
+// Publish Plugin: https://github.com/gradle/plugin-portal-requests/issues/260
+// Shadow:         https://github.com/GradleUp/shadow/pull/1422
+afterEvaluate { project ->
+    project.configurations.named(JavaPlugin.COMPILE_ONLY_CONFIGURATION_NAME) { compileOnly ->
+        compileOnly.dependencies.remove project.dependencies.gradleApi()
+    }
+}
 
 license {
-    header = file('LICENSE-header.txt')
+    header = rootProject.file 'LICENSE-header.txt'
     newLine = false
-    exclude '** /*.properties'
+    exclude '**/*.properties'
 }
 
 tasks.named('jar', Jar) {
     archiveClassifier = 'thin'
 }
 
 tasks.named('shadowJar', ShadowJar) {
-    enableRelocation =  true
+    enableRelocation = true
     archiveClassifier = null
     relocationPrefix = 'net.minecraftforge.gradleutils.shadow'
 }
 
-javadoc.enabled = false
-groovydoc.use = true
-
-// javadocJar is created after evaluation, so we need to configure it here
-afterEvaluate {
-    tasks.named('javadocJar', Jar) {
-        dependsOn tasks.named('groovydoc', Groovydoc)
-        from groovydoc.destinationDir
-    }
+tasks.withType(GroovyCompile).configureEach {
+    groovyOptions.optimizationOptions.indy = true
 }
 
 changelog {
@@ -56,37 +85,51 @@ changelog {
 gradlePlugin {
     website.set gitversion.url
     vcsUrl.set gitversion.url + '.git'
+
+    compatibility {
+        minimumGradleVersion = libs.versions.gradle.get()
+    }
+
+    groovy {
+        withSourcesJar()
+        withGroovydocJar()
+    }
+
     plugins {
-        gradleutils {
+        register('gradleutils') {
             id = 'net.minecraftforge.gradleutils'
             implementationClass = 'net.minecraftforge.gradleutils.GradleUtilsPlugin'
             displayName = projectDisplayName
             description = project.description
-            tags.set(['minecraftforge'])
+            tags = ['minecraftforge']
         }
-        changelog {
+        register('changelog') {
             id = 'net.minecraftforge.changelog'
             implementationClass = 'net.minecraftforge.gradleutils.changelog.ChangelogPlugin'
             displayName = 'Git Changelog'
-            description = 'Creates a changelog text file based on git history using GitVersion'
-            tags.set(['git', 'changelog'])
+            description = 'Creates a changelog text file based on git history using Git Version'
+            tags = ['git', 'changelog']
         }
     }
 }
 
 publishing {
     publications.register('pluginMaven', MavenPublication) {
-        changelog.publish(it)
+        artifactId = project.name
+
+        changelog.publish it
+
         pom { pom ->
-            artifactId = project.name
             name = projectDisplayName
             description = project.description
 
-            gradleutils.pom.gitHubDetails = pom
+            gradleutils.pom.setGitHubDetails pom
 
-            license gradleutils.pom.licenses.LGPLv2_1
+            licenses {
+                license gradleutils.pom.licenses.LGPLv2_1
+            }
 
-            // TODO [GradleUtils] Re-evaluate active developers in GU 3.0
+            // TODO [GradleUtils][GU3.0] Re-evaluate active developers in GU 3.0
             developers {
                 developer gradleutils.pom.developers.LexManos
                 developer gradleutils.pom.developers.SizableShrimp

buildSrc/build.gradle

@@ -3,7 +3,9 @@ org.gradle.parallel=true
 org.gradle.configureondemand=true
 
 # TODO [GradleUtils][Gradle9] Re-enable config cache in Gradle 9
-# Configuration Cache comes with too many bugs to be worth the trouble.
+# Configuration Cache causes issues with plugin publishing.
 # Do continue to make our Gradle plugins (GU, FG7, etc.) support it though.
-org.gradle.configuration-cache=false
-org.gradle.configuration-cache.parallel=false
+#org.gradle.configuration-cache=true
+#org.gradle.configuration-cache.parallel=true
+
+systemProp.org.gradle.unsafe.suppress-gradle-api=true

buildSrc/settings.gradle

@@ -0,0 +1,12 @@
+#This file is generated by updateDaemonJvm
+toolchainUrl.FREE_BSD.AARCH64=https\://api.foojay.io/disco/v3.0/ids/65aaef917b9f394804f058f1861225c9/redirect
+toolchainUrl.FREE_BSD.X86_64=https\://api.foojay.io/disco/v3.0/ids/c728c5388b044fbdbbc44b0c6acee0df/redirect
+toolchainUrl.LINUX.AARCH64=https\://api.foojay.io/disco/v3.0/ids/65aaef917b9f394804f058f1861225c9/redirect
+toolchainUrl.LINUX.X86_64=https\://api.foojay.io/disco/v3.0/ids/c728c5388b044fbdbbc44b0c6acee0df/redirect
+toolchainUrl.MAC_OS.AARCH64=https\://api.foojay.io/disco/v3.0/ids/dc463b4a8183dbcaa1b32544189c7f03/redirect
+toolchainUrl.MAC_OS.X86_64=https\://api.foojay.io/disco/v3.0/ids/cb7dc109dd590ebca2d703734d23c9d3/redirect
+toolchainUrl.UNIX.AARCH64=https\://api.foojay.io/disco/v3.0/ids/65aaef917b9f394804f058f1861225c9/redirect
+toolchainUrl.UNIX.X86_64=https\://api.foojay.io/disco/v3.0/ids/c728c5388b044fbdbbc44b0c6acee0df/redirect
+toolchainUrl.WINDOWS.AARCH64=https\://api.foojay.io/disco/v3.0/ids/43ee83889b87bacad5d3071ae7bbd349/redirect
+toolchainUrl.WINDOWS.X86_64=https\://api.foojay.io/disco/v3.0/ids/2d57bdd1e17a18f83ff073919daa35ba/redirect
+toolchainVersion=17

build_shared.gradle

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradle.properties

@@ -15,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
+#
 
 ##############################################################################
 #
@@ -55,7 +57,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -84,7 +86,7 @@ done
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
 # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
-APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -203,7 +205,7 @@ fi
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Collect all arguments for the java command:
-#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
 #     and any embedded shellness will be escaped.
 #   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
 #     treated as '${Hostname}' itself on the command line.

gradle/gradle-daemon-jvm.properties

@@ -13,6 +13,8 @@
 @rem See the License for the specific language governing permissions and
 @rem limitations under the License.
 @rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
 
 @if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
@@ -43,11 +45,11 @@ set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
 if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -57,11 +59,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 

gradle/wrapper/gradle-wrapper.jar

@@ -1,7 +1,37 @@
+import org.gradle.api.initialization.resolve.RepositoriesMode
+
 plugins {
-    id 'org.gradle.toolchains.foojay-resolver-convention' version '0.7.0'
+    id 'dev.gradleplugins.gradle-plugin-development' version '1.9.0'
+    id 'org.gradle.toolchains.foojay-resolver-convention' version '0.10.0'
 }
 
 rootProject.name = 'gradleutils'
 
-apply from: 'settings_shared.gradle'
+dependencyResolutionManagement {
+    // Repositories are located in build.gradle for this project
+    // dev.gradleplugins.groovy-gradle-plugin is bugged and force adds repositories on the project
+    // so, we can't declare the repositories in here
+    repositoriesMode = RepositoriesMode.PREFER_PROJECT
+
+    versionCatalogs.register('libs') {
+        plugin 'licenser', 'net.minecraftforge.licenser' version '1.2.0'
+        plugin 'gradleutils', 'net.minecraftforge.gradleutils' version '2.5.1'
+        plugin 'plugin-publish', 'com.gradle.plugin-publish' version '1.3.1'
+        plugin 'shadow', 'com.gradleup.shadow' version '9.0.0-beta13'
+
+        // Gradle API
+        version 'gradle', '7.3'
+
+        // Static Analysis
+        library 'nulls', 'org.jetbrains', 'annotations' version '26.0.2'
+
+        // GitHub Actions Workflows
+        library 'yaml', 'org.yaml', 'snakeyaml' version '2.4'
+
+        // Git Version
+        library 'gitver', 'net.minecraftforge', 'gitversion' version '0.5.2'
+
+        // Backwards compatibility
+        library 'jgit', 'org.eclipse.jgit', 'org.eclipse.jgit' version '7.2.0.202503040940-r'
+    }
+}