Merge pull request #106 from ejoerns/topic/doc-release

add documentation for release process

CHANGES

@@ -1,3 +1,6 @@
+Release 1.1 (in development)
+----------------------------
+
 Release 1.0 (released Sep 15, 2021)
 -----------------------------------
 

docs/release-checklist.txt

@@ -0,0 +1,37 @@
+Release Process rauc-hawkbit-updater
+====================================
+
+Preparation
+-----------
+- check for GitHub milestone to be completed
+  - review & merge open PRs if necessary
+- update CHANGES
+- update version in docs/conf.py and CMakeLists.txt
+- create preparation PR, merge PR
+
+Release
+-------
+- update release date in CHANGES and commit
+- create signed git tag::
+
+    git tag -m 'release v1.0' -s -u 925F79DAA74AF221 v1.0
+
+- create source tar archive::
+
+    git archive --format=tar.gz -o rauc-hawkbit-updater-1.0.tar.gz --prefix=rauc-hawkbit-updater-1.0/ v1.0
+
+- sign (and verify) source archive::
+
+    gpg --detach-sign -u 925F79DAA74AF221 --armor rauc-hawkbit-updater-1.0.tar.gz
+    gpg --verify rauc-hawkbit-updater-1.0.tar.gz.asc
+
+- push master commit (if necessary)
+- push signed git tag
+- Creating GitHub release
+  - Start creating release from git tag
+  - upload source archive and signature
+  - add release text using CHANGES::
+
+      pandoc -f rst -t markdown_github CHANGES
+
+  - Submit release button