From b00f255c4029bd25ba024edb6c41278ffc3fae15 Mon Sep 17 00:00:00 2001
From: Eguzki Astiz Lezaun <eastizle@redhat.com>
Date: Fri, 28 Jun 2024 11:37:01 +0200
Subject: [PATCH] doc: release

---
 README.md       |  1 -
 doc/RELEASE.md  | 57 +++++++++++++++++++++++++++++++++++++++++++++++++
 make/release.mk |  7 ++++++
 3 files changed, 64 insertions(+), 1 deletion(-)
 create mode 100644 doc/RELEASE.md
 create mode 100644 make/release.mk

diff --git a/README.md b/README.md
index e151e59..5aace09 100644
--- a/README.md
+++ b/README.md
@@ -35,7 +35,6 @@ This will compile `kuadrantctl` and install it in the `bin` directory at root of
 kuadrantctl [command] [subcommand] [flags]
 ```
 
-
 ### Commands Overview
 
 | Command      | Description                                                |
diff --git a/doc/RELEASE.md b/doc/RELEASE.md
new file mode 100644
index 0000000..442636a
--- /dev/null
+++ b/doc/RELEASE.md
@@ -0,0 +1,57 @@
+## Release
+
+The release process follows a streamlined approach, no release branches involved.
+New releases can be major, minor or patch based releases, but always incrementing digits
+regarding the latest release version.
+
+### New Major.Minor.Patch version
+
+1. Create a new minor release branch from the HEAD of main:
+```sh
+git checkout -b release-vX.Y.Z
+```
+2. Update version (prefixed with **"v"**):
+```sh
+make prepare-release VERSION=vX.Y.Z
+```
+3. Verify local changes:
+```sh
+make install
+bin/kuadrantctl version
+```
+The output should be the new version, for example :
+```
+kuadrantctl v0.3.0 (ff779a1-dirty)
+```
+4. Commit and push:
+```sh
+git add .
+git commit -m "prepare-release: release-vX.Y.Z"
+git push origin release-vX.Y.Z
+```
+5. Create git tag:
+```sh
+git tag -s -m vX.Y.Z vX.Y.Z
+git push origin vX.Y.Z
+```
+6. 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
+
+7. 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
+
+1. Download the latest binary for your platform from the [`kuadrantctl` Latest Releases](https://github.com/Kuadrant/kuadrantctl/releases/latest) page.
+2. Unpack the binary.
+3. Move it to a directory in your `$PATH` so that it can be executed from anywhere.
+4. Check the version:
+```sh
+kuadrantctl version
+```
+The output should be the new version, for example :
+```
+kuadrantctl v0.3.0 (eec318b2e11e7ea5add5e550ff872bde64555d8f)
+```
diff --git a/make/release.mk b/make/release.mk
new file mode 100644
index 0000000..047aaf4
--- /dev/null
+++ b/make/release.mk
@@ -0,0 +1,7 @@
+##@ Release tasks
+
+prepare-release: 
+ifndef VERSION
+	$(error VERSION is undefined)
+endif
+	sed -i 's/Version = ".*"/Version = "$(VERSION)"/' version/version.go