simplify release process

Signed-off-by: Eguzki Astiz Lezaun <[email protected]>

.github/workflows/release.yaml

@@ -27,4 +27,4 @@ jobs:
         goos: ${{ matrix.goos }}
         goarch: ${{ matrix.goarch }}
         goversion: 1.21.4
-        ldflags: -X "github.com/kuadrant/kuadrantctl/version.GitHash=${{ github.sha }}"
+        ldflags: -X "github.com/kuadrant/kuadrantctl/cmd.gitSHA=${{ github.sha }}" -X "github.com/kuadrant/kuadrantctl/cmd.version=${{ github.ref_name }}"

Makefile

@@ -40,6 +40,7 @@ test: clean-cov fmt vet $(GINKGO) ## Run unit tests
 
 
 .PHONY : install
+install: VERSION ?= dev
 install: fmt vet ## Build and install kuadrantctl binary ($GOBIN or GOPATH/bin)
 	@set -e; \
 	GIT_SHA=$$(git rev-parse --short=7 HEAD 2>/dev/null) || { \
@@ -53,7 +54,7 @@ install: fmt vet ## Build and install kuadrantctl binary ($GOBIN or GOPATH/bin)
 			GIT_HASH=$${GIT_SHA}; \
 		fi; \
 	fi; \
-	LDFLAGS="-X 'github.com/kuadrant/kuadrantctl/version.GitHash=$$GIT_HASH'"; \
+	LDFLAGS="-X 'github.com/kuadrant/kuadrantctl/cmd.gitSHA=$$GIT_HASH' -X 'github.com/kuadrant/kuadrantctl/cmd.version=$(VERSION)'"; \
 	GOBIN=$(PROJECT_PATH)/bin $(GO) install -ldflags "$$LDFLAGS";
 
 

RELEASE.md

@@ -0,0 +1,43 @@
+# How to cut a new release
+
+## Process
+
+To release a version _“v0.W.Z”_ of the `kuadrantctl` in GitHub, follow these steps:
+
+1. Create annotated and GPG-signed tag
+
+```sh
+git tag -s v0.W.Z -m "v0.W.Z"
+git push origin v0.W.Z
+```
+
+2. In Github, [create release](https://github.com/Kuadrant/kuadrantctl/releases/new).
+
+* Pick recently pushed git tag
+* Automatically generate release notes from previous released tag
+* Set as the latest release
+
+3. Verify that the build [Release workflow](https://github.com/Kuadrant/kuadrantctl/actions/workflows/release.yaml) is triggered and completes for the new tag
+
+### Verify new release is available
+
+Download `kuadrantctl` binary from [releases](https://github.com/Kuadrant/kuadrantctl/releases) page.
+The binary is available in multiple `OS` and `arch`. Pick your option.
+
+```sh
+wget https://github.com/Kuadrant/kuadrantctl/releases/download/v0.W.Z/kuadrantctl-v0.W.Z-{OS}-{arch}.tar.gz
+
+tar -zxf kuadrantctl-v0.W.Z-{OS}-{arch}.tar.gz
+```
+
+2. Verify version, it should be:
+
+```sh
+./kuadrantctl version
+```
+
+The output should be the expected v0.W.Z and commitID. For example
+
+```
+kuadrantctl v0.3.0 (eec318b2e11e7ea5add5e550ff872bde64555d8f)
+```

cmd/version.go

@@ -4,8 +4,11 @@ import (
 	"fmt"
 
 	"github.com/spf13/cobra"
+)
 
-	"github.com/kuadrant/kuadrantctl/version"
+var (
+	gitSHA  string // value injected in compilation-time
+	version string // value injected in compilation-time
 )
 
 func versionCommand() *cobra.Command {
@@ -14,7 +17,7 @@ func versionCommand() *cobra.Command {
 		Short: "Print the version number of kuadrantctl",
 		Long:  "Print the version number of kuadrantctl",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			fmt.Printf("kuadrantctl %s (%s)\n", version.Version, version.GitHash)
+			fmt.Printf("kuadrantctl %s (%s)\n", version, gitSHA)
 			return nil
 		},
 	}