From 8e0aebc8ad805162a4e00a54561d09441f91008d Mon Sep 17 00:00:00 2001
From: Adam Cattermole <acatterm@redhat.com>
Date: Fri, 22 Nov 2024 16:13:41 +0000
Subject: [PATCH] Add RELEASE.md

Signed-off-by: Adam Cattermole <acatterm@redhat.com>
---
 RELEASE.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 RELEASE.md

diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 0000000..790c665
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,24 @@
+# How to release wasm-shim
+
+To release a version “vX.Y.Z” of the wasm-shim in GitHub and Quay.io, follow these steps:
+
+1. Pick a `<git-ref>` (SHA-1) as source.
+
+```shell
+git checkout <git-ref>
+```
+
+2. Create a new "floating" commit with the release version removing the `-dev`
+   suffix ([example](https://github.com/Kuadrant/wasm-shim/commit/55d785e6f6f56b57184a95b5bf285f43226e8974)).
+
+3. Create a new tag and named release `vX.Y.Z`. Push the tag to GitHub. This will trigger the image to be built in
+   Quay.io.
+
+```shell
+git tag -a vX.Y.Z -m "vX.Y.Z" -s
+git push origin vX.Y.Z
+```
+
+4. Then at the GitHub repository, create a new release from the tag you just pushed, auto-generating the release notes.
+   This will trigger the workflow to build the wasm-shim binary to append to the
+   release ([example](https://github.com/Kuadrant/wasm-shim/releases/tag/v0.8.0)).