From 3568bd9ff486353f502640a4bbff00f04e307f38 Mon Sep 17 00:00:00 2001
From: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com>
Date: Tue, 15 Oct 2024 17:03:42 +0200
Subject: [PATCH] Added a section on changelog management (#151)

---
 RELEASE_PROCESS.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 RELEASE_PROCESS.md

diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
new file mode 100644
index 0000000..d8d218b
--- /dev/null
+++ b/RELEASE_PROCESS.md
@@ -0,0 +1,21 @@
+## Cutting a new release
+
+### Creating the changelog
+
+To create a new release, you will need to have [unclog](https://github.com/informalsystems/unclog) installed.
+
+First, run:
+```
+unclog release vX.Y.Z --editor nano
+```
+This will move all the changelog entries from the `unreleased` folder into a new folder named after the release tag. It will also open an editor for you to write the release notes.
+For the release notes, include the date (as in `Date: October 15th, 2024`). You can
+optionally add a short summary of the release, but do not duplicate the changelog entries.
+
+Then, regenerate the `CHANGELOG` by running
+```
+unclog build > CHANGELOG
+```
+Finally, commit and push the changes to the repo.
+The up-to-date changelog should be present on the release branch for the release you have just cut,
+and also on main. 
\ No newline at end of file