chore: Replace shipkit-auto-version by custom version plugin

Author: bric3

build.gradle

@@ -6,7 +6,7 @@ plugins {
   id 'com.github.spotbugs' version '5.0.14'
   id 'de.thetaphi.forbiddenapis' version '3.8'
 
-  id 'org.shipkit.shipkit-auto-version' version '2.1.2'
+  id 'tracer-version'
   id 'io.github.gradle-nexus.publish-plugin' version '2.0.0'
 
   id 'com.gradleup.shadow' version '8.3.6' apply false
@@ -54,11 +54,8 @@ apply from: "$rootDir/gradle/spotless.gradle"
 
 def compileTask = tasks.register("compile")
 
-def repoVersion = version
-
 allprojects {
   group = 'com.datadoghq'
-  version = repoVersion
 
   if (isCI) {
     buildDir = "$rootDir/workspace/${projectDir.path.replace(rootDir.path, '')}/build/"

buildSrc/build.gradle.kts

@@ -25,6 +25,10 @@ gradlePlugin {
       id = "call-site-instrumentation"
       implementationClass = "datadog.gradle.plugin.CallSiteInstrumentationPlugin"
     }
+    create("tracer-version-plugin") {
+      id = "tracer-version"
+      implementationClass = "datadog.gradle.plugin.version.TracerVersionPlugin"
+    }
   }
 }
 
@@ -42,6 +46,8 @@ dependencies {
   implementation("org.eclipse.aether", "aether-transport-http", "1.1.0")
   implementation("org.apache.maven", "maven-aether-provider", "3.3.9")
 
+  implementation("com.github.zafarkhaja:java-semver:0.10.2")
+
   implementation("com.google.guava", "guava", "20.0")
   implementation("org.ow2.asm", "asm", "9.8")
   implementation("org.ow2.asm", "asm-tree", "9.8")

buildSrc/src/main/kotlin/datadog/gradle/plugin/version/GitDescribeValueSource.kt

@@ -0,0 +1,67 @@
+package datadog.gradle.plugin.version
+
+import org.gradle.api.GradleException
+import org.gradle.api.file.DirectoryProperty
+import org.gradle.api.provider.Property
+import org.gradle.api.provider.ValueSource
+import org.gradle.api.provider.ValueSourceParameters
+import org.gradle.process.ExecOperations
+import org.gradle.process.ExecResult
+import java.io.ByteArrayOutputStream
+import java.nio.charset.Charset
+import javax.inject.Inject
+
+abstract class GitDescribeValueSource @Inject constructor(
+  private val execOperations: ExecOperations
+) : ValueSource<String, GitDescribeValueSource.Parameters> {
+  override fun obtain(): String {
+    val workDir = parameters.workingDirectory.get()
+    val tagPrefix = parameters.tagVersionPrefix.get()
+
+    val commandsArray = mutableListOf(
+      "git",
+      "describe",
+      "--abbrev=8",
+      "--tags",
+      "--first-parent",
+      "--match=$tagPrefix[0-9].[0-9]*.[0-9]",
+    )
+    if (parameters.showDirty.get()) {
+      commandsArray.add("--dirty")
+    }
+
+    val outputStream = ByteArrayOutputStream()
+    val result = try {
+      execOperations.exec {
+        commandLine(commandsArray)
+        workingDir(workDir)
+        standardOutput = outputStream
+        errorOutput = outputStream
+      }
+    } catch (e: Exception) {
+      throw GradleException("Failed to run: ${commandsArray.joinToString(" ")}", e)
+    }
+
+    val output = outputStream.toString(Charset.defaultCharset().name())
+    result.exitValue.let { exitValue ->
+      if (exitValue != 0) {
+        throw GradleException(
+          """
+          Failed to run: ${commandsArray.joinToString(" ")}
+            (exit code: $exitValue)
+          Output:
+          $output
+          """.trimIndent()
+        )
+      }
+    }
+
+    return output
+  }
+
+  interface Parameters : ValueSourceParameters {
+    val tagVersionPrefix: Property<String>
+    val showDirty: Property<Boolean>
+    val workingDirectory: DirectoryProperty
+  }
+}

buildSrc/src/main/kotlin/datadog/gradle/plugin/version/TracerVersionPlugin.kt

@@ -0,0 +1,96 @@
+package datadog.gradle.plugin.version
+
+import com.github.zafarkhaja.semver.Version
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.api.logging.Logging
+import org.gradle.api.model.ObjectFactory
+import org.gradle.api.provider.ProviderFactory
+import org.gradle.kotlin.dsl.property
+import javax.inject.Inject
+
+class TracerVersionPlugin @Inject constructor(
+  private val providerFactory: ProviderFactory,
+) : Plugin<Project> {
+  private val logger = Logging.getLogger(TracerVersionPlugin::class.java)
+
+  override fun apply(targetProject: Project) {
+    if (targetProject.rootProject != targetProject) {
+      throw IllegalStateException("Only root project can apply plugin")
+    }
+
+    val extension = targetProject.extensions.create("tracerVersion", TracerVersionExtension::class.java)
+    val versionProvider = versionProvider(targetProject, extension)
+
+    targetProject.allprojects {
+      version = versionProvider
+    }
+  }
+
+  private fun versionProvider(
+    targetProject: Project,
+    extension: TracerVersionExtension
+  ): String {
+    val workingDirectory = targetProject.projectDir
+
+    val buildVersion: String = if (!workingDirectory.resolve(".git").exists()) {
+      extension.defaultVersion.get()
+    } else {
+      providerFactory.of(GitDescribeValueSource::class.java) {
+        parameters {
+          this.tagVersionPrefix.set(extension.tagVersionPrefix)
+          this.showDirty.set(extension.detectDirty)
+          this.workingDirectory.set(workingDirectory)
+        }
+      }.map {
+        toTracerVersion(it.trim(), extension)
+      }.get()
+    }
+
+    logger.lifecycle("Tracer build version: {}", buildVersion)
+    return buildVersion
+  }
+
+  private fun toTracerVersion(describeString: String, extension: TracerVersionExtension): String {
+    logger.info("Git describe output: {}", describeString)
+
+    val tagPrefix = extension.tagVersionPrefix.get()
+    val tagRegex = Regex("$tagPrefix(\\d+\\.\\d+\\.\\d+)(.*)")
+    val matchResult = tagRegex.find(describeString)
+      ?: return extension.defaultVersion.get()
+
+    val (lastTagVersion, describeTrailer) = matchResult.destructured
+    val hasLaterCommits = describeTrailer.isNotBlank()
+    val version = Version.parse(lastTagVersion).let {
+      if (hasLaterCommits) {
+        it.nextMinorVersion()
+      } else {
+        it
+      }
+    }
+
+    return buildString {
+      append(tagPrefix)
+      append(version.toString())
+
+      if (hasLaterCommits) {
+        append(if (extension.useSnapshot.get()) "-SNAPSHOT" else describeTrailer)
+      }
+
+      if (describeTrailer.endsWith("-dirty")) {
+        append("-dirty")
+      }
+    }
+  }
+
+  open class TracerVersionExtension @Inject constructor(objectFactory: ObjectFactory) {
+    val defaultVersion = objectFactory.property(String::class)
+      .convention("0.1.0-SNAPSHOT")
+    val tagVersionPrefix = objectFactory.property(String::class)
+      .convention("v")
+    val useSnapshot = objectFactory.property(Boolean::class)
+      .convention(true)
+    val detectDirty = objectFactory.property(Boolean::class)
+      .convention(false)
+  }
+}