build: Git-based versioning and simplified release workflow

robinbraemer · robinbraemer · commit 6d6ce0dfebfb · 2026-01-06T13:15:19.000+01:00
- Version now derived from git tags automatically (no manual updates)
- Local dev builds show: {tag}-SNAPSHOT-dirty
- CI branch builds show: {tag}-SNAPSHOT
- CI release builds show: exact tag version (e.g., 0.8.0)

Release workflow simplified:
- Create release in GitHub UI with tag (e.g., 0.8.0)
- CI automatically builds and uploads artifacts to the release
- Branch pushes create/update latest-prerelease
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,90 +1,77 @@
-name: release
+name: Release
 
 on:
+  # Trigger on GitHub UI release creation
+  release:
+    types: [published]
+  # Trigger on branch push for pre-releases
   push:
-    branches: [ connect ]
-    tags: [ "*.*.*" ]
+    branches: [connect]
 
 jobs:
-
   build:
     runs-on: ubuntu-latest
     permissions:
       contents: write
-    env:
-      RELEASE_DIR: release
-      LATEST_RELEASE_DIR: latest/release
-      LATEST_PRERELEASE_DIR: latest/prerelease
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch all history for git describe
 
       - name: Set up JDK 17
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
           java-version: '17'
+          cache: 'gradle'
 
       - name: Setup Gradle
-        uses: gradle/gradle-build-action@v2
+        uses: gradle/actions/setup-gradle@v3
 
-      - name: Build with Maven
+      - name: Build
         run: ./gradlew build
 
-      - name: Rename JARs for Latest Pre-Release
-        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
+      - name: Get version
+        id: version
         run: |
-          mkdir -p ${LATEST_PRERELEASE_DIR}
-          cp spigot/build/libs/connect-spigot.jar ${LATEST_PRERELEASE_DIR}/connect-spigot-prerelease.jar
-          cp velocity/build/libs/connect-velocity.jar ${LATEST_PRERELEASE_DIR}/connect-velocity-prerelease.jar
-          cp bungee/build/libs/connect-bungee.jar ${LATEST_PRERELEASE_DIR}/connect-bungee-prerelease.jar
+          VERSION=$(./gradlew properties -q | grep "^version:" | awk '{print $2}')
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Building version: $VERSION"
 
-      - name: Rename JARs for Latest Release
-        if: startsWith(github.ref, 'refs/tags/')
-        run: |
-          mkdir -p ${LATEST_RELEASE_DIR}
-          cp spigot/build/libs/connect-spigot.jar ${LATEST_RELEASE_DIR}/connect-spigot.jar
-          cp velocity/build/libs/connect-velocity.jar ${LATEST_RELEASE_DIR}/connect-velocity.jar
-          cp bungee/build/libs/connect-bungee.jar ${LATEST_RELEASE_DIR}/connect-bungee.jar
+      # For release events: upload artifacts to the release
+      - name: Upload Release Artifacts
+        if: github.event_name == 'release'
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            spigot/build/libs/connect-spigot.jar
+            velocity/build/libs/connect-velocity.jar
+            bungee/build/libs/connect-bungee.jar
+            LICENSE
 
-      - name: Rename JARs for Release
-        if: startsWith(github.ref, 'refs/tags/')
+      # For branch push: create/update pre-release
+      - name: Prepare Pre-Release Artifacts
+        if: github.event_name == 'push'
         run: |
-          mkdir -p ${RELEASE_DIR}
-          REF=${GITHUB_REF##*/}
-          cp spigot/build/libs/connect-spigot.jar ${RELEASE_DIR}/connect-spigot-${REF}.jar
-          cp velocity/build/libs/connect-velocity.jar ${RELEASE_DIR}/connect-velocity-${REF}.jar
-          cp bungee/build/libs/connect-bungee.jar ${RELEASE_DIR}/connect-bungee-${REF}.jar
+          mkdir -p prerelease
+          cp spigot/build/libs/connect-spigot.jar prerelease/connect-spigot-prerelease.jar
+          cp velocity/build/libs/connect-velocity.jar prerelease/connect-velocity-prerelease.jar
+          cp bungee/build/libs/connect-bungee.jar prerelease/connect-bungee-prerelease.jar
 
-      - name: Latest Pre Release
-        uses: marvinpinto/action-automatic-releases@latest
-        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
+      - name: Update Pre-Release
+        if: github.event_name == 'push'
+        uses: softprops/action-gh-release@v1
         with:
-          repo_token: ${{ secrets.GH_TOKEN }}
-          automatic_release_tag: latest-prerelease
+          tag_name: latest-prerelease
+          name: "Latest Pre-Release (${{ steps.version.outputs.version }})"
           prerelease: true
-          title: Latest Pre-Release
           files: |
-            latest/prerelease/*.jar
+            prerelease/*.jar
             LICENSE
+          body: |
+            Automated pre-release build from `connect` branch.
 
-      - name: Latest Release
-        uses: marvinpinto/action-automatic-releases@latest
-        if: startsWith(github.ref, 'refs/tags/')
-        with:
-          repo_token: ${{ secrets.GH_TOKEN }}
-          automatic_release_tag: latest
-          prerelease: false
-          title: Latest Release
-          files: |
-            latest/release/*.jar
-            LICENSE
+            **Version:** ${{ steps.version.outputs.version }}
+            **Commit:** ${{ github.sha }}
 
-      - name: Release version
-        uses: marvinpinto/action-automatic-releases@latest
-        if: startsWith(github.ref, 'refs/tags/')
-        with:
-          repo_token: ${{ secrets.GH_TOKEN }}
-          prerelease: false
-          files: |
-            release/*.jar
-            LICENSE
+            ⚠️ This is a development build and may be unstable.
diff --git a/build-logic/src/main/kotlin/extensions.kt b/build-logic/src/main/kotlin/extensions.kt
@@ -27,16 +27,99 @@ import net.kyori.indra.git.IndraGitExtension
 import org.gradle.api.Project
 import org.gradle.api.artifacts.ProjectDependency
 import org.gradle.kotlin.dsl.the
+import java.io.ByteArrayOutputStream
+
+/**
+ * Calculates the version from git tags.
+ * - For tagged commits: returns the tag (e.g., "0.7.0")
+ * - For non-tagged commits: returns "{last-tag}-SNAPSHOT" (e.g., "0.7.0-SNAPSHOT")
+ * - For dirty working tree: appends "-dirty"
+ */
+fun Project.gitVersion(): String {
+    // Check if GITHUB_REF_TYPE is "tag" - if so, use the tag name directly
+    val refType = System.getenv("GITHUB_REF_TYPE")
+    val refName = System.getenv("GITHUB_REF_NAME")
+    if (refType == "tag" && !refName.isNullOrEmpty()) {
+        return refName.removePrefix("v")
+    }
+
+    // Try to get version from git describe
+    return try {
+        val stdout = ByteArrayOutputStream()
+        exec {
+            commandLine("git", "describe", "--tags", "--always", "--dirty")
+            standardOutput = stdout
+            isIgnoreExitValue = true
+        }
+        val describe = stdout.toString().trim()
+
+        if (describe.isEmpty()) {
+            "0.0.0-SNAPSHOT"
+        } else {
+            parseGitDescribe(describe)
+        }
+    } catch (e: Exception) {
+        "0.0.0-SNAPSHOT"
+    }
+}
+
+/**
+ * Parses git describe output into a version string.
+ * Examples:
+ * - "0.7.0" -> "0.7.0" (exactly on tag)
+ * - "v0.7.0" -> "0.7.0" (exactly on tag with v prefix)
+ * - "0.7.0-5-gabcdef" -> "0.7.0-SNAPSHOT" (5 commits after tag)
+ * - "0.7.0-5-gabcdef-dirty" -> "0.7.0-SNAPSHOT-dirty" (with uncommitted changes)
+ * - "abcdef" -> "0.0.0-SNAPSHOT" (no tags, just commit hash)
+ * - "abcdef-dirty" -> "0.0.0-SNAPSHOT-dirty"
+ */
+private fun parseGitDescribe(describe: String): String {
+    val isDirty = describe.endsWith("-dirty")
+    val cleanDescribe = describe.removeSuffix("-dirty")
+
+    // Pattern: tag-commits-hash or just tag or just hash
+    val parts = cleanDescribe.split("-")
+
+    val version = when {
+        // Just a hash (no tags exist)
+        parts.size == 1 && parts[0].matches(Regex("[a-f0-9]+")) -> "0.0.0-SNAPSHOT"
+        // Exactly on a tag: "0.7.0" or "v0.7.0"
+        parts.size == 1 -> parts[0].removePrefix("v")
+        // Tag with v prefix split: "v0", "7", "0" - rejoin
+        parts[0] == "v" || parts[0].startsWith("v") -> {
+            // Check if this looks like a versioned tag with commits after
+            if (parts.size >= 3 && parts[parts.size - 1].startsWith("g")) {
+                // Has commits after tag: "v0.7.0-5-gabcdef" or "0.7.0-5-gabcdef"
+                val tagParts = parts.dropLast(2) // Remove commit count and hash
+                tagParts.joinToString("-").removePrefix("v") + "-SNAPSHOT"
+            } else {
+                // Just the tag, possibly with dashes in it
+                cleanDescribe.removePrefix("v")
+            }
+        }
+        // Tag-commits-hash format: "0.7.0-5-gabcdef"
+        parts.size >= 3 && parts[parts.size - 1].startsWith("g") -> {
+            val tagParts = parts.dropLast(2)
+            tagParts.joinToString("-").removePrefix("v") + "-SNAPSHOT"
+        }
+        // Some other format, use as-is
+        else -> cleanDescribe.removePrefix("v")
+    }
+
+    return if (isDirty) "$version-dirty" else version
+}
 
 fun Project.isSnapshot(): Boolean =
-    version.toString().endsWith("-SNAPSHOT")
+    version.toString().contains("-SNAPSHOT")
 
 fun Project.fullVersion(): String {
-    var version = version.toString()
-    if (version.endsWith("-SNAPSHOT")) {
-        version += " (b${buildNumberAsString()}-${lastCommitHash()})"
+    val ver = version.toString()
+    return if (ver.contains("-SNAPSHOT")) {
+        val commitHash = lastCommitHash() ?: "unknown"
+        ver.replace("-SNAPSHOT", "-SNAPSHOT+$commitHash")
+    } else {
+        ver
     }
-    return version
 }
 
 fun Project.lastCommitHash(): String? =
@@ -45,9 +128,9 @@ fun Project.lastCommitHash(): String? =
 // retrieved from https://wiki.jenkins-ci.org/display/JENKINS/Building+a+software+project
 // some properties might be specific to Jenkins
 fun Project.branchName(): String =
-    System.getenv("GIT_BRANCH") ?: "local/dev"
+    System.getenv("GIT_BRANCH") ?: System.getenv("GITHUB_REF_NAME") ?: "local/dev"
 fun Project.buildNumber(): Int =
-    Integer.parseInt(System.getenv("BUILD_NUMBER") ?: "-1")
+    Integer.parseInt(System.getenv("BUILD_NUMBER") ?: System.getenv("GITHUB_RUN_NUMBER") ?: "-1")
 
 fun Project.buildNumberAsString(): String =
     buildNumber().takeIf { it != -1 }?.toString() ?: "??"
@@ -76,4 +159,4 @@ fun Project.relocate(pattern: String) =
         .add(pattern)
 
 private fun calcExclusion(section: String, bit: Int, excludedOn: Int): String =
-    if (excludedOn and bit > 0) section else ""
+    if (excludedOn and bit > 0) section else ""
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -6,7 +6,7 @@ plugins {
 
 allprojects {
     group = "com.minekube.connect"
-    version = "0.7.0"
+    version = gitVersion()
     description =
         "Connects the server/proxy to the global Connect network to reach more players while also supporting online mode server, bungee or velocity mode. Visit https://minekube.com/connect"
 }

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ plugins {`
`6`	`6`
`7`	`7`	`allprojects {`
`8`	`8`	`group = "com.minekube.connect"`
`9`		`- version = "0.7.0"`
	`9`	`+ version = gitVersion()`
`10`	`10`	`description =`
`11`	`11`	`"Connects the server/proxy to the global Connect network to reach more players while also supporting online mode server, bungee or velocity mode. Visit https://minekube.com/connect"`
`12`	`12`	`}`