SIRF 3.7.0 Release Checklist

[evgueni-ovtchinnikov]

Release Checklist

VER=3.7.0

1. Submodules (within SIRF)

• 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

• update CHANGES.md
• update NOTICE.txt
• update CITATION.cff
• update version numbers in SIRF/CMakeLists.txt
• update version numbers in the doc/UsersGuide.md etc
• run all demos
• run ctest
• git push
• check the build
• run doxygen, check, send files for uploading and update the doxygen link on Wiki
• git tag -a v$VER -m "version $VER"
• git push origin v$VER
• 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

• update CHANGES.md
• update NOTICE.txt
• update CITATION.cff
• update SIRF-Superbuild/version_config.cmake with new SIRF_TAG (and STIR_TAG etc if necessary)
• update CIL and CCPi-Regularisation version and reinstate tests SIRF-SuperBuild#897 (will have conflicts on SIRF_TAG with the previous one).
• Sadly, ROOT still fails to compile so we need attempt to use system ROOT SIRF-SuperBuild#901 at the moment.
• update version number in VM_version.txt
• update vb.name in vagrant/vagrantfile
• git push
• check the build
• git tag -a v$VER -m "version $VER"
• git push origin v$VER
• 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

• git tag -a v$VER -m "version $VER"
• git push origin v$VER

5. Virtual Machine

• vagrant up
• Virtualbox Guest Additions
• run first_run.sh script (gnome settings and zero-fill trick)
• check that the serial port is deselected.
• export the VM
• ctest on VM
• run all exercises (download data first)
• 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)

• git tag -a v$VER -m "version $VER"
• git push origin v$VER

7. Website (if final release)

• update Software page (version info, VM etc)
• upload doxygen
• 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

• git clone https://github.com/SyneRBI/SIRF.wiki.git; cd SIRF.wiki (or pull)
• git tag -a v$VER -m "version $VER"
• git push origin v$VER

[KrisThielemans]

I've done final textual changes on the SIRF-SuperBuild.

@evgueni-ovtchinnikov what's stopping you from tagging SIRF? Once done, finishing off the SuperBuild and other tagging will be trivial.

Given current work-load, I suggest we don't do the VM at the moment (it could be trivial, but...). We can tell people to use update_VM.sh -s in their current VM.

[evgueni-ovtchinnikov]

@KrisThielemans I believe we should merge PR #1241 first (and Challenge24 PR #3) so that Challenge participants will use SIRF 3.7.0, should we not?

[KrisThielemans]

I think #1241 will likely take more time (I've just reviewed it). I've also created #1259 which I'd like to have for the challenge (for at least a few things).

So I think we should release 3.7/0 now,

[KrisThielemans]

I've tagged SIRF-Contribs and SIRF-Exercises. I've created SyneRBI/SIRF-SuperBuild#902.
@casperdcl @paskino I believe we need SyneRBI/SIRF-SuperBuild#897 (will have conflicts on SIRF_TAG with the previous one). Sadly, ROOT still fails to compile so we need SyneRBI/SIRF-SuperBuild#898 at the moment.
@paskino, @casperdcl can you finish those ?

[KrisThielemans]

We won't upload a new VM. Sorry.

So all done.