From 9fde849aa1cdd4787f45b1afc50eab14f4248b54 Mon Sep 17 00:00:00 2001 From: Simon Rit Date: Tue, 22 Nov 2022 09:34:16 +0100 Subject: [PATCH] DOC: Added Release.md which descries how to prepare a release --- documentation/Release.md | 42 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 documentation/Release.md diff --git a/documentation/Release.md b/documentation/Release.md new file mode 100644 index 000000000..0be0ce2e5 --- /dev/null +++ b/documentation/Release.md @@ -0,0 +1,42 @@ + +# How to prepare an RTK release + +Check ITK's instructions and update this wiki page accordingly. + +## Prepare release message + +Based on previous messages (`git show tags`). + +``` +git log --no-merges v2.4.0..HEAD --pretty=format:"%h; %an; %ad: %s" >release_notes.txt +git log --no-merges v2.4.0..HEAD --pretty=format:"%an" | sort -u >contributors.txt +``` + +## Prepare repository + +* Modify the RTK release number(s) in `CMakeLists.txt`, +* Modify the RTK release number and the required ITK version for Python packages in `setup.py`. +* Tag git repository on this change with a copy of the release message. + +## Backup Doxygen documentation + +``` +ctest -S /home/srit/src/rtk/rtk-dashboard/russula_doxygen.cmake -V +cd /home/srit/src/rtk/RTK-website/ +mv /home/srit/src/rtk/dashboard_tests/RTK-Doxygen/Doxygen/html Doxygen241 +./sync.sh +``` + +## Prepare website + +Create news message in `RTK/news`, update `rtkindex.html` and `RTK/news/lefthand.html` accordingly. + +Update page `RTK/resources/software.html`. + +## Advertise + +Post message on the mailing list [`rtk-users@openrtk.org`](mailto:rtk-users@openrtk.org). + +## Verify binaries + +Binaries will now be posted by GitHub actions when tagging the repository, simply verify that the Github action goes well and that the packages have been posted once it is over.