Add information how to make a release

yaml · Jan 18, 2022 · b1f6a90 · b1f6a90
1 parent 45db50a
commit b1f6a90
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/doc/release.md b/doc/release.md
@@ -0,0 +1,30 @@
+## 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 tag -a data-$RELEASEDATE
+    # enter in editor:
+        # data-$RELEASEDATE
+        #
+        # Longer release details
+    git push origin data-$RELEASEDATE
+