From 48a5ed7a3b53ba3362771abeacf24eb39f2b7fc8 Mon Sep 17 00:00:00 2001
From: Paul Campbell <pcampbell@kemitix.net>
Date: Sun, 25 Aug 2024 19:28:47 +0100
Subject: [PATCH] docs: add notes on how to do a release

---
 RELEASE.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 RELEASE.md

diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 0000000..007f18a
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,18 @@
+# How to create a new Release
+
+## TLDR
+
+1. Merge PR `chore: release`
+2. Wait for `push-main` workflow to complete
+3. Replace Release Notes body with details from CHANGELOG (remove crates and duplicates)
+4. Update thread: <https://mitra.kemitix.net/post/01907ef5-5bd9-b0b6-2b8a-e29762541d78>
+
+## Detail
+
+The workflow in `.forgejo/workflows/push-main.yaml` will create or update a PR whenever `main` branch is updated.
+
+The create the new release, merge this PR. It will automatically create the Release on the `git-next` repo, and publish crates to <https://crates/io>.
+
+The Release notes that are included with the create Release are currently incorrect, and will need to be manually updated from the `CHANGELOG.md`. Remove crate headers and any resulting duplicates.
+
+Post an update to the Fediverse. See link above.