Creating a new Release

This page highlights the steps one needs to follow to create a new release for CaPTk. It is done in the form of a final PR before each release (since the master is protected).

Source level checks

Make sure model files have been updated to reflect the most recent major/minor/patch versions. So, for example, if you are updating from 1.9.0 to 1.9.1.Alpha, update the model version numbers to "1.9.1".

NITRC

Project Page is https://www.nitrc.org/projects/captk/

0. Ensure you have admin or maintainer level access before proceeding.
1. To create a new numbered release:

• Follow the prompts under "Downloads > Admin" to create the new numbered release and give the appropriate alpha/beta/RC/final designation.
• Add all relevant information (release notes, changelog, so on).
• Add URLs as download options (use one of the older release links to create the NITRC-generated links).
  • Ensure there are 3 files present in the release, 1 each for Windows, Linux and macOS.
• Once a new numbered release has been created, the NITRC-generated links become active, and they are used to track downloads.
• Once the release is created, you have the option to keep it hidden (this can be done for testing the download mechanism).
• Use the NITRC-generated links for all 3 platforms, and update GitHub's main main Readme.md file.
  • For example, for Windows x64 on the 1.8.2 release, it is "https://www.nitrc.org/frs/downloadlink.php/12376".

2. To update a previous numbered release with a new alpha/beta/RC/final designation:

• Go to "Downloads > Admin".
• Select "Edit existing release".
• Select appropriate numbered release and then "Edit".
• If applicable, update the information (release date, changelog, so on) for the release
• Update the files links (after they are uploaded to the NITRC servers)

GitHub

• Change version in CMakeLists.txt.
• Update versions in all pre-packaged models (currently, we only have DeepMedic models).
• If creating a new numbered release, update the download links in Readme.md.
• Build documentation locally, so that the html files are updated.
• Create the pull request (this will update the documentation and create new builds on Azure).
• Publish installers to NITRC.
• Create the tag on GitHub:

git tag -a X.Y.Z -m "put description of the version here"
git push origin --tags

Upload to NITRC

• Once builds are finished, download artifacts locally.
• Copy the installers to the NITRC location "/home/groups/captk/htdocs" (this is the new secure location in NITRC).