Add ability to create preview-releases

Author: nikita-vanyasin

CHANGELOG.md

@@ -5,7 +5,7 @@
 - Fix possible deadlock and goroutine leak while waiting for child process termination
 - Change INF level to WRN or ERR when child process terminated with non-zero
 
-## [1.16.0](https://github.com/arangodb-helper/arangodb/tree/1.16.0) (2023-07-21)
+## [0.16.0](https://github.com/arangodb-helper/arangodb/tree/1.16.0) (2023-07-21)
 - Add sanity check for pass-through args usage
 - Fix printing --starter.instance-up-timeout instead of hardcoded value
 - Fix context handling in WaitUntilStarterReady for tests

Makefile

@@ -222,6 +222,15 @@ release-minor: $(RELEASE)
 release-major: $(RELEASE)
 	$(RELEASE) -type=major
 
+prerelease-patch: $(RELEASE)
+	$(RELEASE) -type=patch -prerelease
+
+prerelease-minor: $(RELEASE)
+	$(RELEASE) -type=minor -prerelease
+
+prerelease-major: $(RELEASE)
+	$(RELEASE) -type=major -prerelease
+
 TESTCONTAINER := arangodb-starter-test
 
 # Run all unit tests

tools/release/release.go

@@ -30,19 +30,26 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"time"
 
 	"github.com/coreos/go-semver/semver"
 )
 
+const (
+	preReleasePrefix = "preview-"
+)
+
 var (
 	versionFile string // Full path of VERSION file
 	releaseType string // What type of release to create (major|minor|patch)
 	ghRelease   string // Full path of github-release tool
 	ghUser      string // Github account name to create release in
 	ghRepo      string // Github repository name to create release in
 	binFolder   string // Folder containing binaries
+	preRelease  bool   // If set, mark release as preview
+	dryRun      bool   // If set, do not really push a release or any git changes
 
 	binaries = map[string]string{
 		"arangodb-darwin-amd64":      "darwin/amd64/arangodb",
@@ -60,20 +67,22 @@ func init() {
 	flag.StringVar(&ghUser, "github-user", "arangodb-helper", "Github account name to create release in")
 	flag.StringVar(&ghRepo, "github-repo", "arangodb", "Github repository name to create release in")
 	flag.StringVar(&binFolder, "bin-folder", "./bin", "Folder containing binaries")
+	flag.BoolVar(&preRelease, "prerelease", false, "If set, mark release as preview")
+	flag.BoolVar(&dryRun, "dryrun", false, "If set, do not really push a release or any git changes")
 }
 
 func main() {
 	flag.Parse()
 	ensureGithubToken()
 	checkCleanRepo()
-	version := bumpVersion(releaseType)
+	version := bumpVersionInFile(releaseType)
 	make("clean")
 	make("binaries")
 	createSHA256Sums()
-	make("docker-push-version")
+	pushDockerImages()
 	gitTag(version)
 	githubCreateRelease(version)
-	bumpVersion("devel")
+	bumpVersionInFile("devel")
 }
 
 // ensureGithubToken makes sure the GITHUB_TOKEN envvar is set.
@@ -100,33 +109,36 @@ func checkCleanRepo() {
 	}
 }
 
+func pushDockerImages() {
+	if dryRun {
+		log.Printf("Skipping pushing docker images to registry")
+	} else {
+		make("docker-push-version")
+	}
+}
+
 func make(target string) {
 	if err := run("make", target); err != nil {
 		log.Fatalf("Failed to make %s: %v\n", target, err)
 	}
 }
 
-func bumpVersion(action string) string {
-	contents, err := ioutil.ReadFile(versionFile)
+func bumpVersionInFile(action string) string {
+	contents, err := os.ReadFile(versionFile)
 	if err != nil {
 		log.Fatalf("Cannot read '%s': %v\n", versionFile, err)
 	}
 	version := semver.New(strings.TrimSpace(string(contents)))
+	bumpVersion(version, action, preRelease)
 
-	switch action {
-	case "patch":
-		version.BumpPatch()
-	case "minor":
-		version.BumpMinor()
-	case "major":
-		version.BumpMajor()
-	case "devel":
-		version.Metadata = "git"
-	}
 	contents = []byte(version.String())
 
-	if err := ioutil.WriteFile(versionFile, contents, 0755); err != nil {
-		log.Fatalf("Cannot write '%s': %v\n", versionFile, err)
+	if dryRun {
+		log.Printf("Skipping writing VERSION file. Content: %s", string(contents))
+	} else {
+		if err := os.WriteFile(versionFile, contents, 0755); err != nil {
+			log.Fatalf("Cannot write '%s': %v\n", versionFile, err)
+		}
 	}
 
 	gitCommitAll(fmt.Sprintf("Updated to %s", version))
@@ -135,7 +147,70 @@ func bumpVersion(action string) string {
 	return version.String()
 }
 
+func bumpVersion(version *semver.Version, action string, isPreRelease bool) {
+	if action == "devel" {
+		version.Metadata = "git"
+		return
+	}
+	version.Metadata = ""
+
+	currVersionIsPreRelease := strings.HasPrefix(string(version.PreRelease), preReleasePrefix)
+	if isPreRelease {
+		firstPreRelease := semver.PreRelease(fmt.Sprintf("%s1", preReleasePrefix))
+		switch action {
+		case "patch":
+			if currVersionIsPreRelease {
+				version.PreRelease = bumpPreReleaseIndex(version.PreRelease)
+			} else {
+				version.BumpPatch()
+				version.PreRelease = firstPreRelease
+			}
+		case "minor":
+			if currVersionIsPreRelease && version.Patch == 0 {
+				version.PreRelease = bumpPreReleaseIndex(version.PreRelease)
+			} else {
+				version.BumpMinor()
+				version.PreRelease = firstPreRelease
+			}
+		case "major":
+			if currVersionIsPreRelease && version.Minor == 0 && version.Patch == 0 {
+				version.PreRelease = bumpPreReleaseIndex(version.PreRelease)
+			} else {
+				version.BumpMajor()
+				version.PreRelease = firstPreRelease
+			}
+		}
+	} else {
+		version.PreRelease = ""
+		if !currVersionIsPreRelease {
+			switch action {
+			case "patch":
+				version.BumpPatch()
+			case "minor":
+				version.BumpMinor()
+			case "major":
+				version.BumpMajor()
+			}
+		}
+	}
+}
+
+func bumpPreReleaseIndex(preReleaseStr semver.PreRelease) semver.PreRelease {
+	indexStr := strings.TrimPrefix(string(preReleaseStr), preReleasePrefix)
+	index, err := strconv.Atoi(indexStr)
+	if err != nil {
+		log.Fatalf("Could not parse prerelease: %s", preReleaseStr)
+	}
+	index++
+	return semver.PreRelease(fmt.Sprintf("%s%d", preReleasePrefix, index))
+}
+
 func gitCommitAll(message string) {
+	if dryRun {
+		log.Printf("Skipping git commit and push with message '%s'", message)
+		return
+	}
+
 	args := []string{
 		"commit",
 		"--all",
@@ -150,6 +225,11 @@ func gitCommitAll(message string) {
 }
 
 func gitTag(version string) {
+	if dryRun {
+		log.Printf("Skipping git tag with name '%s'", version)
+		return
+	}
+
 	if err := run("git", "tag", version); err != nil {
 		log.Fatalf("Failed to tag: %v\n", err)
 	}
@@ -176,6 +256,11 @@ func createSHA256Sums() {
 }
 
 func githubCreateRelease(version string) {
+	if dryRun {
+		log.Printf("Skipping github release with tag name '%s'", version)
+		return
+	}
+
 	// Create draft release
 	args := []string{
 		"release",
@@ -184,6 +269,9 @@ func githubCreateRelease(version string) {
 		"--tag", version,
 		"--draft",
 	}
+	if preRelease {
+		args = append(args, "--pre-release")
+	}
 	if err := run(ghRelease, args...); err != nil {
 		log.Fatalf("Failed to create github release: %v\n", err)
 	}
@@ -217,6 +305,9 @@ func githubCreateRelease(version string) {
 		"--repo", ghRepo,
 		"--tag", version,
 	}
+	if preRelease {
+		args = append(args, "--pre-release")
+	}
 	if err := run(ghRelease, args...); err != nil {
 		log.Fatalf("Failed to finalize github release: %v\n", err)
 	}