From 249f2b0ff0caecf4bcbc2a337fd81d752ce414ec Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tina=20M=C3=BCller?= <cpan2@tinita.de>
Date: Tue, 18 Jan 2022 20:56:21 +0100
Subject: [PATCH] Add information how to make a release

---
 doc/release.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 doc/release.md

diff --git a/doc/release.md b/doc/release.md
new file mode 100644
index 00000000..33bb9d7c
--- /dev/null
+++ b/doc/release.md
@@ -0,0 +1,33 @@
+## How to make a release
+
+Make sure main and data are in a clean state.
+
+    export RELEASEDATE=2022-01-17
+    # Release for the main branch
+    git tag -a v$RELEASEDATE
+    # enter in editor:
+        # v$RELEASEDATE
+        #
+        # Longer release details
+    git push origin v$RELEASEDATE
+    # Prepare data directory
+    cd data
+    # Avoid the tag being part of a branch that might be squashed
+    git co --orphan data-release
+    git rm --cached -r .
+    rm -r *
+    cd ..
+    make data-update
+    # check
+    make data-status
+    cd data
+    # `git add` should already been done by make data-status
+    # git status
+    git commit -m "Generated from main <sha>"
+    git tag -a data-$RELEASEDATE
+    # enter in editor:
+        # data-$RELEASEDATE
+        #
+        # Longer release details
+    git push origin data-$RELEASEDATE
+