replace gradle-git-versioning with custom implementation (because the plugin doesn't support config cache)

Author: aSemy

build.gradle.kts

@@ -2,23 +2,15 @@ import buildsrc.config.excludeGeneratedGradleDsl
 
 plugins {
   idea
-  id("me.qoomon.git-versioning")
   id("org.jetbrains.kotlinx.kover")
   buildsrc.convention.base
 }
 
 
 project.group = "dev.adamko.kxstsgen"
-project.version = "0.0.0-SNAPSHOT"
-gitVersioning.apply {
-  refs {
-    considerTagsOnBranches = true
-    branch(".+") { version = "\${ref}-SNAPSHOT" }
-    tag("v(?<version>.*)") { version = "\${ref.version}" }
-  }
-
-  // optional fallback configuration in case of no matching ref configuration
-  rev { version = "\${commit}" }
+project.version = object {
+  val gitVersion = project.gitVersion
+  override fun toString(): String = gitVersion.get()
 }
 
 idea {
@@ -32,3 +24,12 @@ idea {
     )
   }
 }
+
+val projectVersion by tasks.registering {
+  description = "prints the project version"
+  group = "help"
+  val version = providers.provider { project.version }
+  doLast {
+    logger.quiet("${version.orNull}")
+  }
+}

buildSrc/build.gradle.kts

@@ -7,7 +7,6 @@ dependencies {
 
   implementation(libs.gradlePlugin.kotlin)
   implementation(libs.gradlePlugin.kotlinSerialization)
-  implementation(libs.gradlePlugin.gitVersioning)
   implementation(libs.gradlePlugin.gradleNode)
   implementation(libs.gradlePlugin.kotlinxKover)
   implementation(libs.gradlePlugin.kotlinxKnit)

gradle/libs.versions.toml

@@ -5,7 +5,7 @@ kotlinTarget = "1.8"
 
 kotlin = "1.8.22"                        # https://github.com/JetBrains/kotlin/releases
 
-kotlinSymbolProcessing = "1.9.0-1.0.13" # https://github.com/google/ksp/releases
+kotlinSymbolProcessing = "1.9.0-1.0.13"  # https://github.com/google/ksp/releases
 kotlinCompileTesting = "1.5.0"           # https://github.com/tschuchortdev/kotlin-compile-testing/releases
 
 kotlinx-serialization = "1.5.1"          # https://github.com/Kotlin/kotlinx.serialization/releases/
@@ -22,7 +22,6 @@ kotlinProcess = "1.4.1"                  # https://github.com/pgreze/kotlin-proc
 classgraph = "4.8.162"                   # https://github.com/classgraph/classgraph/releases
 
 gradleNodePlugin = "4.0.0"               # https://github.com/node-gradle/gradle-node-plugin/releases
-gitVersioningPlugin = "6.4.2"            # https://github.com/qoomon/gradle-git-versioning-plugin/releases
 
 [libraries]
 
@@ -68,7 +67,6 @@ kotlinx-knit-test = { module = "org.jetbrains.kotlinx:kotlinx-knit-test", versio
 
 gradlePlugin-kotlin = {  module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
 gradlePlugin-kotlinSerialization = {  module = "org.jetbrains.kotlin:kotlin-serialization", version.ref = "kotlin" }
-gradlePlugin-gitVersioning = { module = "me.qoomon:gradle-git-versioning-plugin", version.ref = "gitVersioningPlugin" }
 gradlePlugin-gradleNode = { module = "com.github.node-gradle:gradle-node-plugin", version.ref = "gradleNodePlugin" }
 gradlePlugin-kotlinxKover = { module = "org.jetbrains.kotlinx:kover", version.ref = "kotlinx-kover" }
 gradlePlugin-kotlinxKnit = { module = "org.jetbrains.kotlinx:kotlinx-knit", version.ref = "kotlinx-knit" }

settings.gradle.kts

@@ -1,3 +1,5 @@
+@file:Suppress("UnstableApiUsage")
+
 rootProject.name = "kotlinx-serialization-typescript-generator"
 
 pluginManagement {
@@ -7,7 +9,6 @@ pluginManagement {
   }
 }
 
-@Suppress("UnstableApiUsage")
 dependencyResolutionManagement {
   repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
 
@@ -53,3 +54,65 @@ include(
 
 enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
 enableFeaturePreview("STABLE_CONFIGURATION_CACHE")
+
+//region git versioning
+val gitDescribe: Provider<String> =
+  providers
+    .exec {
+      workingDir(rootDir)
+      commandLine(
+        "git",
+        "describe",
+        "--always",
+        "--tags",
+        "--dirty=-SNAPSHOT",
+        "--broken=-SNAPSHOT",
+        "--match=v[0-9]*\\.[0-9]*\\.[0-9]*",
+      )
+      isIgnoreExitValue = true
+    }.standardOutput.asText.map { it.trim() }
+
+val currentBranchName: Provider<String> =
+  providers
+    .exec {
+      workingDir(rootDir)
+      commandLine(
+        "git",
+        "branch",
+        "--show-current",
+      )
+      isIgnoreExitValue = true
+    }.standardOutput.asText.map { it.trim() }
+
+val currentCommitHash: Provider<String> =
+  providers.exec {
+    workingDir(rootDir)
+    commandLine(
+      "git",
+      "rev-parse",
+      "--short",
+      "HEAD",
+    )
+    isIgnoreExitValue = true
+  }.standardOutput.asText.map { it.trim() }
+
+val gitVersion: Provider<String> =
+  gitDescribe.zip(currentBranchName) { described, branch ->
+    val snapshot = if ("SNAPSHOT" in described) "-SNAPSHOT" else ""
+
+    val descriptions = described.split("-")
+
+    if (branch.isNullOrBlank() && descriptions.size in 1..2) {
+      // detached if there's no current branch, or if 'git described' indicates additional commits
+      val tag = descriptions.getOrNull(0)
+      "$tag$snapshot"
+    } else {
+      // current commit is attached
+      "$branch$snapshot"
+    }
+  }.orElse(currentCommitHash)
+
+gradle.allprojects {
+  extensions.add<Provider<String>>("gitVersion", gitVersion)
+}
+//endregion