Merge pull request #16 from itk-dev/feature/release-type

Added version check to determine release type

Author: rimi-itk

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+* [PR-16](https://github.com/itk-dev/gh-itkdev/pull/16)
+  Added version check to determine release type
 * [PR-15](https://github.com/itk-dev/gh-itkdev/pull/15)
   Added “Under udvikling” as allowed “Unreleased” header
 

changelog/release.go

@@ -11,10 +11,36 @@ import (
 	"slices"
 	"strings"
 	"time"
+
+	"golang.org/x/mod/semver"
 )
 
+func getBranchName(release string) (string, error) {
+	version := release
+	if !strings.HasPrefix(version, "v") {
+		version = "v" + version
+	}
+	if !semver.IsValid(version) {
+		return "", fmt.Errorf("invalid version: %s", release)
+	}
+
+	branchType := "release"
+	// Determine if the release is a "release" or a "hotfix".
+	//
+	// A "hotfix" is a version that's not a prerelease and has a patch version different from 0 (cf. https://semver.org/).
+	if semver.Prerelease(version) == "" && semver.MajorMinor(version)+".0" != version {
+		branchType = "hotfix"
+	}
+
+	return branchType + "/" + release, nil
+}
+
 func createReleaseBranch(release string, base string) (string, error) {
-	branch := "release/" + release
+	branch, err := getBranchName(release)
+	if err != nil {
+		return "", err
+	}
+
 	cmd := exec.Command("git", "checkout", "-b", branch, base)
 	output, err := cmd.CombinedOutput()
 	if err != nil {

changelog/release_test.go

@@ -8,6 +8,63 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+func TestBranchName(t *testing.T) {
+	testCases := []struct {
+		release   string
+		expected  string
+		errorText string
+	}{
+		{
+			"v0.0.0",
+			"release/v0.0.0",
+			"",
+		},
+		{
+			"hest",
+			"",
+			"invalid version: hest",
+		},
+		{
+			"v0.0.1",
+			"hotfix/v0.0.1",
+			"",
+		},
+		{
+			"v1.0.0",
+			"release/v1.0.0",
+			"",
+		},
+		{
+			"1.0.0",
+			"release/1.0.0",
+			"",
+		},
+		{
+			"v1.0.0-rc1",
+			"release/v1.0.0-rc1",
+			"",
+		},
+		// Apart from testing, having release candidates for at patch release may not make sense.
+		{
+			"v1.0.1-rc1",
+			"release/v1.0.1-rc1",
+			"",
+		},
+	}
+
+	for _, testCase := range testCases {
+		actual, err := getBranchName(testCase.release)
+
+		if testCase.errorText != "" {
+			assert.NotNil(t, err)
+			assert.EqualError(t, err, testCase.errorText)
+		} else {
+			assert.Nil(t, err)
+			assert.Equal(t, testCase.expected, actual)
+		}
+	}
+}
+
 func TestRelease(t *testing.T) {
 	testCases := []struct {
 		changelog string

go.mod

@@ -1,11 +1,14 @@
 module github.com/itk-dev/gh-itkdev
 
-go 1.23
+go 1.23.0
+
+toolchain go1.24.1
 
 require (
 	github.com/cli/go-gh v1.2.1
 	github.com/spf13/cobra v1.8.0
 	github.com/stretchr/testify v1.9.0
+	golang.org/x/mod v0.24.0
 )
 
 require (

go.sum

@@ -50,6 +50,8 @@ github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsT
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e h1:BuzhfgfWQbX0dWzYzT1zsORLnHRv3bcRcsaUk0VmXA8=
 github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e/go.mod h1:/Tnicc6m/lsJE0irFMA0LfIwTBo4QP7A8IfyIv4zZKI=
+golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU=
+golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww=
 golang.org/x/net v0.0.0-20220923203811-8be639271d50/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk=
 golang.org/x/net v0.7.0 h1:rJrUqqhjsgNp7KqAIc25s9pZnjU7TUcSY7HcVZjdn1g=
 golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=