Release 3.5.0 checklist

[evgueni-ovtchinnikov]

Release Checklist

Set version variable of the release for further steps:

VER=3.5.0

1. Submodules (within SIRF)
   • [x] tag data
   • git submodule update # should not complain
   • cd data && git tag -a v$VER -m "version $VER" && git push --tags && cd ..
   • git status # should not list data as modified
2. SIRF
   • [x] update CHANGES.md
   • [x] update NOTICE.txt
   • [x] update CITATION.cff
   • [x] update version numbers in SIRF/CMakeLists.txt
   • [x] update version numbers in the doc/UsersGuide.md etc
   • [x] run all demos
   • [x] run ctest
   • [x] git push
   • [x] check Travis
   • [x] run doxygen, check, send files for uploading and update the doxygen link on Wiki
   • [x] git tag -a v$VER -m "version $VER"
   • [x] git push origin v$VER
   • [x] if final release only: create release on https://github.com/SyneRBI/SIRF/releases/new linked to the tag and copying all CHANGES.md since last release (as listed on https://github.com/SyneRBI/SIRF/releases)
3. SuperBuild
   • [x] update CHANGES.md
   • [x] update NOTICE.txt
   • [x] update CITATION.cff
   • [x] update SIRF-Superbuild/version_config.cmake with new SIRF_TAG (and STIR_TAG etc if necessary)
   • [x] update version number in VM_version.txt
   • [x] update vb.name in vagrant/vagrantfile
   • [x] git push
   • [x] check Travis
   • [x] git tag -a v$VER -m "version $VER"
   • [x] git push origin v$VER
   • [x] if final release only: create release on https://github.com/SyneRBI/SIRF-SuperBuild/releases/new linked to the tag and copying all CHANGES.md since last release (as listed on https://github.com/SyneRBI/SIRF-SuperBuild/releases)
4. SIRF-Contribs
   • [x] git tag -a v$VER -m "version $VER"
   • [x] git push origin v$VER
5. Virtual Machine
   • [x] vagrant up
   • [x] VirtualBox Guest Additions (Devices > insert VBGA CD > run autorun.sh)
   • [x] run first_run.sh script (gnome settings and zero-fill trick)
   • [x] check that the serial port is deselected.
   • [x] export the VM (File > Export Appliance)
   • [x] ctest on VM (start exported machine, run gadgetron & ; ctest ~/devel/buildVM)
   • [x] run all exercises (download data first)
   • [x] upload to Zenodo
     • use name like SIRF 2.2.0.ova (with space) as Zenodo uses alphabetical ordering probably, add -release-candidate-1 if necessary (as most people will not know what rc1 means).
6. SIRF-Exercises (already checked in VM)
   • [x] git tag -a v$VER -m "version $VER"
   • [x] git push origin v$VER
7. Website (if final release)
   • [ ] update Software page (version info, VM etc)
   • [x] upload doxygen
   • [x] update link for doxygen in Wiki
   • [ ] add news flash
8. Announce
   • [ ] Send email to SyneRBI-DEVEL@JISCMAIL.AC.UK; SyneRBI-USERS@JISCMAIL.AC.UK; add SyneRBI@JISCMAIL.AC.UK for final release
9. Tag wiki
   • [x] git clone https://github.com/SyneRBI/SIRF.wiki.git; cd SIRF.wiki (or pull)
   • [x] git tag -a v$VER -m "version $VER"
   • [x] git push origin v$VER

[casperdcl]

fyi Zenodo's been down for a few days, so SIRF tests (which rely on Zenodo datasets) and VM down/uploads aren't currently working.

[casperdcl]

finally managed to upload https://zenodo.org/records/10033962 :)