Cleanup and Git Version Plugin API change

- Small buildscript cleanup.
- The `GitVersionExtension` class is now the public facing API for Git Version in the Gradle plugin.
  - Use `gitversion.tagOffset` instead of `gitversion.version.tagOffset`.
  - Many parts of Git Version API such as getting a directory now use Gradle's `DirectoryProperty` when applicable.
- If configuration cache is not requested, Git Version will not disable reading from the system's Git config.
- PomUtils cleanup.
  - `Developers` renamed to `developers` (now lowercase) to match `licenses`. The uppercase field will be removed in GU 3.0.
  - Licenses now use the SPDX identifier as the name and `repo` as the distribution, as recommended by the [reference spec](https://maven.apache.org/pom.html#Licenses).
- All-around code cleanup.
- Documentation is not a focus this time.

Author: Jonathing

build.gradle

@@ -1,35 +1,37 @@
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+
 plugins {
     id 'java-gradle-plugin'
     id 'groovy'
     id 'idea'
+    id 'eclipse'
     id 'maven-publish'
     id 'net.minecraftforge.licenser' version '1.1.1'
-    id 'com.gradle.plugin-publish' version '1.2.1'
     id 'net.minecraftforge.gradleutils'
+    id 'com.gradle.plugin-publish' version '1.3.1'
     id 'com.gradleup.shadow' version '8.3.6'
 }
 
+final projectDisplayName = 'Forge Gradle Utilities'
+description = 'Small collection of utilities for standardizing MinecraftForge gradle scripts'
 group = 'net.minecraftforge'
-version = gitversion.version.tagOffset
+version = gitversion.tagOffset
+
 println "Version: $version"
 
 apply from: 'build_shared.gradle'
 
-tasks.withType(GroovyCompile).configureEach {
-    groovyOptions.optimizationOptions.indy = true
-}
-
 license {
     header = file('LICENSE-header.txt')
     newLine = false
     exclude '** /*.properties'
 }
 
-jar {
+tasks.named('jar', Jar) {
     archiveClassifier = 'thin'
 }
 
-tasks.named('shadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar) {
+tasks.named('shadowJar', ShadowJar) {
     enableRelocation =  true
     archiveClassifier = null
     relocationPrefix = 'net.minecraftforge.gradleutils.shadow'
@@ -41,7 +43,7 @@ groovydoc.use = true
 // javadocJar is created after evaluation, so we need to configure it here
 afterEvaluate {
     tasks.named('javadocJar', Jar) {
-        dependsOn groovydoc
+        dependsOn tasks.named('groovydoc', Groovydoc)
         from groovydoc.destinationDir
     }
 }
@@ -51,24 +53,45 @@ changelog {
     publishAll = false
 }
 
+gradlePlugin {
+    website = gitversion.url
+    vcsUrl = "${gitversion.url}.git"
+    plugins {
+        gradleutils {
+            id = 'net.minecraftforge.gradleutils'
+            implementationClass = 'net.minecraftforge.gradleutils.GradleUtilsPlugin'
+            displayName = projectDisplayName
+            description = project.description
+            tags.set(['minecraftforge'])
+        }
+        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'])
+        }
+    }
+}
+
 publishing {
     publications.register('pluginMaven', MavenPublication) {
         changelog.publish(it)
         pom { pom ->
-            artifactId = 'gradleutils'
-            name = 'Gradle Utils'
-            description = 'Used by MinecraftForge projects as a util library for Gradle buildscripts'
+            artifactId = project.name
+            name = projectDisplayName
+            description = project.description
 
             gradleutils.pom.gitHubDetails = pom
 
             license gradleutils.pom.licenses.LGPLv2_1
 
             // TODO [GradleUtils] Re-evaluate active developers in GU 3.0
             developers {
-                developer gradleutils.pom.Developers.LexManos
-                developer gradleutils.pom.Developers.SizableShrimp
-                developer gradleutils.pom.Developers.Paint_Ninja
-                developer gradleutils.pom.Developers.Jonathing
+                developer gradleutils.pom.developers.LexManos
+                developer gradleutils.pom.developers.SizableShrimp
+                developer gradleutils.pom.developers.Paint_Ninja
+                developer gradleutils.pom.developers.Jonathing
             }
         }
     }

buildSrc/build.gradle

@@ -4,10 +4,13 @@ plugins {
 
 apply from: '../build_shared.gradle'
 
-sourceSets {
-    main {
-        groovy {
-            srcDirs = ['../src/main/groovy']
+sourceSets.main.groovy.srcDirs = ['../src/main/groovy']
+
+gradlePlugin {
+    plugins {
+        gradleutils {
+            id = 'net.minecraftforge.gradleutils'
+            implementationClass = 'net.minecraftforge.gradleutils.GradleUtilsPlugin'
         }
     }
 }

build_shared.gradle

@@ -1,10 +1,13 @@
-
 java {
     // GitVersion requires Java 17
     toolchain.languageVersion = JavaLanguageVersion.of(17)
     withSourcesJar()
 }
 
+tasks.withType(GroovyCompile).configureEach {
+    groovyOptions.optimizationOptions.indy = true
+}
+
 repositories {
     maven { url = 'https://maven.minecraftforge.net' }
     maven { url = 'https://repo.eclipse.org/content/groups/releases/' }
@@ -28,24 +31,3 @@ dependencies {
     // TODO - Deprecated git utilities, remove in 3.0
     implementation libs.jgit
 }
-
-gradlePlugin {
-    website = 'https://github.com/MinecraftForge/GradleUtils'
-    vcsUrl = 'https://github.com/MinecraftForge/GradleUtils.git'
-    plugins {
-        gradleutils {
-            id = 'net.minecraftforge.gradleutils'
-            implementationClass = 'net.minecraftforge.gradleutils.GradleUtilsPlugin'
-            displayName = 'Forge Gradle Utilities'
-            description = 'Small collection of utilities for standardizing our gradle scripts'
-            tags.set(['minecraftforge'])
-        }
-        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'])
-        }
-    }
-}

gradle.properties

@@ -2,3 +2,5 @@ org.gradle.caching=true
 org.gradle.parallel=true
 org.gradle.configureondemand=true
 org.gradle.configuration-cache=true
+org.gradle.configuration-cache.parallel=true
+org.gradle.configuration-cache.problems=warn

settings.gradle

@@ -2,6 +2,6 @@ plugins {
     id 'org.gradle.toolchains.foojay-resolver-convention' version '0.7.0'
 }
 
-rootProject.name = 'GradleUtils'
+rootProject.name = 'gradleutils'
 
 apply from: 'settings_shared.gradle'

src/main/groovy/net/minecraftforge/gradleutils/ConfigureTeamCity.groovy

@@ -18,7 +18,7 @@ import javax.inject.Inject
 /**
  * This task prints the marker lines into the log which configure the pipeline.
  *
- * @deprecated Will be removed once Forge moves off of TeamCity
+ * @deprecated Will be removed once Forge moves off of TeamCity.
  */
 @CompileStatic
 @Deprecated(forRemoval = true)
@@ -33,26 +33,24 @@ abstract class ConfigureTeamCity extends DefaultTask {
         project.tasks.register(name, ConfigureTeamCity)
     }
 
-    @Inject
-    abstract ProviderFactory getProviders()
+    @Inject abstract ProviderFactory getProviders()
 
     ConfigureTeamCity() {
         this.description = 'Prints the marker lines into the log which configure the pipeline. [deprecated]'
         this.onlyIf('Only runs on TeamCity, so the TEAMCITY_VERSION environment variable must be set.') { GradleUtils.hasEnvVar('TEAMCITY_VERSION', this.providers).get() }
 
-        this.version.convention this.providers.provider { this.project.version?.toString() }
+        this.buildNumber.convention this.providers.provider { this.project.version?.toString() }
     }
 
-    /** The version string to print, usually the {@linkplain Project#getVersion() project version}. */
-    @Input
-    abstract Property<String> getVersion()
+    /** The build number to print, usually the project version. */
+    abstract @Input Property<String> getBuildNumber()
 
     @TaskAction
     void exec() {
         this.logger.warn 'WARNING: Usage of TeamCity is deprecated within Minecraft Forge Minecraft Forge has been gradually moving off of TeamCity and into GitHub Actions. When the migration is fully complete, this task along with its automatic setup will be removed.'
 
         this.logger.lifecycle 'Setting project variables and parameters.'
-        println "##teamcity[buildNumber '${this.version.get()}']"
-        println "##teamcity[setParameter name='env.PUBLISHED_JAVA_ARTIFACT_VERSION' value='${this.version.get()}']"
+        println "##teamcity[buildNumber '${this.buildNumber.get()}']"
+        println "##teamcity[setParameter name='env.PUBLISHED_JAVA_ARTIFACT_VERSION' value='${this.buildNumber.get()}']"
     }
 }

src/main/groovy/net/minecraftforge/gradleutils/GenerateActionsWorkflow.groovy

@@ -5,6 +5,7 @@
 package net.minecraftforge.gradleutils
 
 import groovy.transform.CompileStatic
+import groovy.transform.PackageScope
 import net.minecraftforge.gradleutils.gitversion.GitVersionExtension
 import org.gradle.api.DefaultTask
 import org.gradle.api.Project
@@ -24,60 +25,39 @@ import javax.inject.Inject
 
 /**
  * This task generates the GitHub Actions workflow file for the project, respecting declared subprojects in Git Version.
- * <p>
- * This can be very useful when creating new projects or subprojects.
+ * <p>This can be very useful when creating new projects or subprojects.</p>
  */
 @CompileStatic
 abstract class GenerateActionsWorkflow extends DefaultTask {
     public static final String NAME = 'generateActionsWorkflow'
 
-    static TaskProvider<GenerateActionsWorkflow> register(Project project) {
-        register(project, NAME)
+    @PackageScope static TaskProvider<GenerateActionsWorkflow> register(Project project) {
+        project.tasks.register(NAME, GenerateActionsWorkflow)
     }
 
-    static TaskProvider<GenerateActionsWorkflow> register(Project project, String name) {
-        project.tasks.register(name, GenerateActionsWorkflow)
-    }
-
-    @Inject
-    abstract ProviderFactory getProviders()
+    @Inject abstract ProviderFactory getProviders()
 
     GenerateActionsWorkflow() {
         this.description = 'Generates the GitHub Actions workflow file for the project, respecting declared subprojects in Git Version.'
 
         this.outputFile.convention this.project.rootProject.layout.projectDirectory.file(this.providers.provider { "build_${this.project.name}.yaml" })
 
         this.projectName.convention this.providers.provider { this.project.name }
-        this.branch.convention this.providers.provider { this.project.extensions.getByType(GitVersionExtension).version.info.branch }
-        this.localPath.convention this.providers.provider { this.project.extensions.getByType(GitVersionExtension).version.projectPath }
-        this.paths.convention this.providers.provider { this.project.extensions.getByType(GitVersionExtension).version.subprojectPaths.collect { "!${it}/**".toString() } }
+        this.branch.convention this.providers.provider { this.project.extensions.getByType(GitVersionExtension).info.branch }
+        this.localPath.convention this.project.extensions.getByType(GitVersionExtension).projectPath
+        this.paths.convention this.providers.provider { this.project.extensions.getByType(GitVersionExtension).subprojectPaths.get().collect { "!${it}/**".toString() } }
         this.gradleJavaVersion.convention 21
         this.sharedActionsBranch.convention 'v0'
     }
 
-    @OutputFile
-    abstract RegularFileProperty getOutputFile()
-
-    @Input
-    abstract Property<String> getProjectName()
-
-    @Input
-    @Optional
-    abstract Property<String> getBranch()
-
-    @Input
-    @Optional
-    abstract Property<String> getLocalPath()
-
-    @Input
-    @Optional
-    abstract ListProperty<String> getPaths()
-
-    @Input
-    abstract Property<Integer> getGradleJavaVersion()
+    abstract @OutputFile RegularFileProperty getOutputFile()
 
-    @Input
-    abstract Property<String> getSharedActionsBranch()
+    abstract @Input Property<String> getProjectName()
+    abstract @Input @Optional Property<String> getBranch()
+    abstract @Input @Optional Property<String> getLocalPath()
+    abstract @Input @Optional ListProperty<String> getPaths()
+    abstract @Input Property<Integer> getGradleJavaVersion()
+    abstract @Input Property<String> getSharedActionsBranch()
 
     @TaskAction
     void exec() throws IOException {