Updated version calculation for release branches (#27)

Author: orchestr7

.github/workflows/build_and_test.yml

@@ -5,6 +5,7 @@ on:
   push:
     branches:
       - 'main'
+      - 'release/**'
 
 env:
   GRADLE_OPTS: -Dorg.gradle.daemon=true -Dorg.gradle.parallel=true -Dorg.gradle.welcome=never
@@ -18,7 +19,11 @@ jobs:
         os: [ ubuntu-latest ]
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          # release workflow should have access to all tags
+          fetch-depth: 0
       - uses: gradle/actions/wrapper-validation@v4
       - name: Set up JDK 21
         uses: actions/setup-java@v4

.github/workflows/release.yml

@@ -2,8 +2,8 @@ name: Create release to Maven Central
 
 on:
   push:
-    tags:
-      - 'v*'
+    branches:
+      - 'release/**'
 
 env:
   PGP_SEC: ${{ secrets.PGP_SEC }}

core/src/main/kotlin/com/akuleshov7/vercraft/core/Branch.kt

@@ -36,8 +36,8 @@ public class Branch(git: Git, public val ref: Ref) {
             if (commitInBranch.id.name == startCommit.id.name) {
                 if (!endFound) {
                     throw IllegalStateException(
-                        "Invalid commit order: Head commit '${endCommit.id.toString().substring(0, 5)}' was found " +
-                                "before the starting commit '${startCommit.id.toString().substring(0, 5)}'. "
+                        "Invalid commit order: Head commit '${endCommit.name.toString().substring(0, 5)}' was found " +
+                                "before the starting commit '${startCommit.name.toString().substring(0, 5)}'. "
                     )
                 }
                 return count
@@ -50,8 +50,8 @@ public class Branch(git: Git, public val ref: Ref) {
 
         // If we complete the loop without finding both commits, return -1
         throw IllegalArgumentException(
-            "Not able to find neither commit ${startCommit.id.toString().substring(0, 5)}, " +
-                    "nor commit ${endCommit.id.toString().substring(0, 5)}"
+            "Not able to find neither commit ${startCommit.name.toString().substring(0, 5)}, " +
+                    "nor commit ${endCommit.name.toString().substring(0, 5)}"
         )
     }
 

core/src/main/kotlin/com/akuleshov7/vercraft/core/Releases.kt

@@ -163,19 +163,21 @@ public class Releases public constructor(private val git: Git, private val confi
         val releaseBranchesFromRemote = getAndFilterReleaseBranches(git.branchList().setListMode(REMOTE))
         val localReleaseBranches = getAndFilterReleaseBranches(git.branchList().setListMode(null))
 
-        // we will make a union of LOCAL branches and REMOTE, with a priority to LOCAL
-        val allReleaseBranches = (localReleaseBranches + releaseBranchesFromRemote)
+        // we will make a union of LOCAL branches and REMOTE, with a priority to REMOTE
+        // TODO: think about it once again - for LOCAL case and detached HEAD may be it will be more useful to use LOCAL
+        // TODO: for CI case - definitely REMOTE (there is no LOCAL branches for CI)
+        // TODO: if there are differences and changes in LOCAL branch, but we are using remote, there will be more commits and we will fail
+        val allReleaseBranches = (releaseBranchesFromRemote + localReleaseBranches)
             .groupBy { it.branch.ref.name.shortName(config.remote) }
 
         allReleaseBranches.keys.forEach {
             val value = allReleaseBranches[it]
             if (value!!.size > 1) {
                 if (value[0].branch.gitLog != value[1].branch.gitLog) {
-                    // TODO: error when release branch is checked-out (and calculating version for it) and differs from remote
                     logger.warn(
                         "$ERROR_PREFIX Remote and local branches '$it' differ. " +
-                                "Do you have any unpublished changes in your local branch? Will use " +
-                                "local branch to calculate versions."
+                                "Do you have any non-pushed commits in your local branch? Will use " +
+                                "remote branch to calculate versions."
                     )
                 }
             }

core/src/main/kotlin/com/akuleshov7/vercraft/core/VersionCalculator.kt

@@ -142,8 +142,9 @@ public class VersionCalculator(
             ?: throw IllegalStateException(
                 "Can't find common ancestor commits between ${config.defaultMainBranch} " +
                         "and ${currentCheckoutBranch.ref.name} branches. Looks like these branches have no relation " +
-                        "and that is inconsistent git state."
+                        "and that is an inconsistent git state."
             )
+
         return currentCheckoutBranch.distanceBetweenCommits(baseCommit, headCommit)
     }
 }