From 8a08cc2712ad0bc43cd911c0240c2ce08cd878c7 Mon Sep 17 00:00:00 2001
From: Paul Meyer <49727155+katexochen@users.noreply.github.com>
Date: Fri, 9 Feb 2024 14:44:11 +0100
Subject: [PATCH] dev-docs: document patch release

Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
---
 dev-docs/release.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 dev-docs/release.md

diff --git a/dev-docs/release.md b/dev-docs/release.md
new file mode 100644
index 0000000000..ddfc01c93d
--- /dev/null
+++ b/dev-docs/release.md
@@ -0,0 +1,38 @@
+# How to release
+
+# Minor
+
+
+# Patch
+
+1. Ensure all needed PRs were backported to the current release branch, and all backport PRs were merged.
+
+2. Export the release you want to make:
+
+    ```sh
+    export REL_VER=v0.1.1
+    export CUR_VER="$(echo $REL_VER | awk -F. -v OFS=. '{$NF -= 1 ; print}')"
+
+    echo "Releasing $CUR_VER -> $REL_VER"
+    ```
+3. Checkout the current release branch:
+
+   ```sh
+   git switch "release/${REL_VER%.*}"
+   ```
+
+4. Create a new temporary branch for the relese:
+
+    ```sh
+    git switch -c "tmp/$REL_VER"
+    git push
+    ```
+
+5. Trigger the release workflow
+
+    ```sh
+    gh workflow run release.yml --ref $(git rev-parse --abbrev-ref HEAD) -f kind=patch -f version="$REL_VER"
+    ```
+6. Review the release notes, test the binary artifact.
+
+7. Publish the GitHub release.