Simplify the release process a bit

- Get rid of VERSION file and use `git describe --tags --always`. - Update stable.txt after the release is published to avoid the situation where Cilium CI tries to fetch a version that hasn't been released. Ref: https://git-scm.com/docs/git-describe#_examples Signed-off-by: Michi Mutsuzaki <[email protected]>
cilium · Aug 10, 2021 · ad173af · ad173af
1 parent debe453
commit ad173af
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 78 deletions.
diff --git a/Makefile b/Makefile
@@ -4,9 +4,7 @@ GO_TAGS ?=
 TARGET=cilium
 INSTALL = $(QUIET)install
 BINDIR ?= /usr/local/bin
-VERSION=$(shell cat VERSION)
-GIT_BRANCH = $(shell which git >/dev/null 2>&1 && git rev-parse --abbrev-ref HEAD)
-GIT_HASH = $(shell which git >/dev/null 2>&1 && git rev-parse --short HEAD)
+VERSION=$(shell git describe --tags --always)
 
 TEST_TIMEOUT ?= 5s
 RELEASE_UID ?= $(shell id -u)
@@ -18,8 +16,6 @@ GOLANGCILINT_VERSION = $(shell golangci-lint version 2>/dev/null)
 $(TARGET):
 	$(GO_BUILD) $(if $(GO_TAGS),-tags $(GO_TAGS)) \
 		-ldflags "-w -s \
-		-X 'github.com/cilium/cilium-cli/internal/cli/cmd.GitBranch=${GIT_BRANCH}' \
-		-X 'github.com/cilium/cilium-cli/internal/cli/cmd.GitHash=$(GIT_HASH)' \
 		-X 'github.com/cilium/cilium-cli/internal/cli/cmd.Version=${VERSION}'" \
 		-o $(TARGET) \
 		./cmd/cilium

diff --git a/RELEASE.md b/RELEASE.md
@@ -12,28 +12,26 @@ copy-pasting.
 
 ### Version
 
-If releasing a new version 5.4.0 with the latest release being 5.3.8, for
+If releasing a new version v5.4.0 with the latest release being v5.3.8, for
 example, they will look as follows:
 
-    export MAJOR=5
-    export MINOR=4
-    export PATCH=0
-    export LAST_RELEASE=5.3.8
-    export NEXT_PATCH=$((PATCH+1))
+    export RELEASE=v5.4.0
+    export LAST_RELEASE=v5.3.8
 
-## Create release prep branch
+### Commit SHA to release
 
-This branch will be used to prepare all the necessary things to get ready for
-release.
+    export COMMIT_SHA=<commit-sha-to-release>
 
-    git checkout -b pr/v$MAJOR.$MINOR.$PATCH-prep
+## Tag a release
+
+    git tag -a $RELEASE -m '$RELEASE release' $COMMIT_SHA && git push origin $RELEASE
 
 ## Prepare the release notes
 
 Using https://github.com/cilium/release, prepare the release notes between the
 last minor version (latest patch) and current.
 
-    ./release --repo cilium/cilium-cli --base v$LAST_RELEASE --head master
+    ./release --repo cilium/cilium-cli --base $LAST_RELEASE --head $COMMIT_SHA
     **Other Changes:**
     * install: Add a hidden --base-version flag (#418, @michi-covalent)
     * Makefile: introduce GO_BUILD variable (#432, @tklauser)
@@ -42,58 +40,22 @@ last minor version (latest patch) and current.
     * skip Succeeded pods (#431, @xyz-li)
     ... etc ...
 
-## Update files for the new release
-
-Update the version in `VERSION` and `stable.txt`, then commit the changes to
-the prep branch:
-
-    echo $MAJOR.$MINOR.$PATCH > VERSION
-    echo v$MAJOR.$MINOR.$PATCH > stable.txt
-    git add VERSION stable.txt
-    git commit -s -m "Prepare for release v$MAJOR.$MINOR.$PATCH"
-
-Consider that the Cilium repository uses the version specified in `stable.txt`
-in the master branch for its CI workflows. In certain cases (e.g. for breaking
-changes which require changes in the Cilium repo first), the version in
-`stable.txt` might need to be updated in a separate PR.
-
-## Update the `VERSION` file for next development cycle
-
-Usually this only consists of bumping the patch version and adding the `-dev`
-suffix, e.g.
-
-    echo $MAJOR.$MINOR.${NEXT_PATCH}-dev > VERSION
-
-Then commit the changes to the release prep branch:
-
-    git add VERSION
-    git commit -s -m "Prepare for v$MAJOR.$MINOR.$NEXT_PATCH development"
-
-## Push the prep branch and open a Pull Request
-
-The pull request has to be `pr/v$MAJOR.$MINOR.$PATCH-prep -> master`
-
-Once the pull request is approved and merged, a tag can be created.
-
-## Tag a release
-
-Identify the right commit and tag the release. Usually, the commit modifying
-the version in the `VERSION` file is tagged.
-
-Example:
-
-    git tag -a v0.8.5 -m 'v0.8.5 release' <commit-sha>
+## Update the GitHub release notes
 
-Then push the tag.
+When a tag is pushed, a GitHub Action job takes care of creating a new GitHub
+draft release, building artifacts and attaching them to the draft release. Once
+the draft is ready, copy & paste the generated release notes manually and publish
+the release.
 
-Example:
+## Update stable.txt
 
-    git push origin v0.8.5
+The Cilium repository uses the version specified in `stable.txt` in the master branch
+for its CI workflows. Update `stable.txt` when Cilium needs to pick up this new release
+for its CI workflows:
 
-## Update the GitHub release notes
-
-When a tag is pushed, a GitHub Action job takes care of creating a new GitHub
-draft release, building artifacts and attaching them to the draft release.
+    git checkout -b pr/update-stable-to-$RELEASE
+    echo $RELEASE > stable.txt
+    git add stable.txt
+    git commit -s -m "Update the stable version to $RELEASE"
 
-The release notes need to be manually added before manually publishing the
-release.
+Then open a pull request against `master` branch.
diff --git a/internal/cli/cmd/version.go b/internal/cli/cmd/version.go
@@ -30,10 +30,6 @@ import (
 var (
 	// Version is the software version.
 	Version string
-	// GitBranch is the name of the git branch HEAD points to.
-	GitBranch string
-	// GitHash is the git checksum of the most recent commit in HEAD.
-	GitHash string
 )
 
 func getLatestStableVersion() string {
@@ -57,16 +53,9 @@ func newCmdVersion() *cobra.Command {
 		Short: "Display detailed version information",
 		Long:  `Displays information about the version of this software.`,
 		Run: func(cmd *cobra.Command, _ []string) {
-			var gitInfo string
-			switch {
-			case GitBranch != "" && GitHash != "":
-				gitInfo = fmt.Sprintf("@%s-%s", GitBranch, GitHash)
-			case GitHash != "":
-				gitInfo = fmt.Sprintf("@%s", GitHash)
-			}
 			// TODO: add support for reporting the Cilium version running in
 			// the cluster, if any. See https://github.com/cilium/cilium-cli/issues/131
-			fmt.Printf("cilium-cli: v%s%s compiled with %v on %v/%v\n", Version, gitInfo, runtime.Version(), runtime.GOOS, runtime.GOARCH)
+			fmt.Printf("cilium-cli: %s compiled with %v on %v/%v\n", Version, runtime.Version(), runtime.GOOS, runtime.GOARCH)
 			fmt.Printf("cilium image (default): %s\n", defaults.Version)
 			fmt.Printf("cilium image (stable): %s\n", getLatestStableVersion())
 		},