These are the typical steps required to finalize a release of OpenSim
Creator.
How comprehensively the QA/testing steps are done is entirely dependent
on how many changes were made since the last release (assuming an automated
test suite isn't available that covers the changes).
[x] Create an issue called something like Release XX.xx.pp
[x] Copy this checklist into it
[x] Bump OSC's version number in CMakeLists.txt (project)
[x] Clean-build a debug version of OSC:
git clone --recurse-submodules https://github.com/ComputationalBiomechanicsLab/opensim-creator
cd opensim-creator
./scripts/build_linux_debugging.sh
[x] Ensure test suite passes with debug+ASAN build
[x] Manually spot-check new changes with debug+ASAN build
[x] Fix all bugs/problems found during the above steps
[x] Update CHANGELOG.md sections such that the current unreleased
section becomes XX.xx.pp and then add a new unreleased section
above that
[x] Commit any fixes to CI and ensure CI passes
[x] Tag+push the commit as a release
[x] Download artifacts from the tagged commit CI build
[x] Unzip/rename any artifacts (see prev. releases)
[x] Create new release on github from the tagged commit
Upload all artifacts against it
Write a user-friendly version of CHANGELOG that explains changes
[x] Update Zenodo with the release (requires adamkewley's Zenodo login
to publish the automatically generated draft)
[x] Update content with Zenodo details:
[x] Use bump_zenodo_details.py to automatically do this
Release Checklist
These are the typical steps required to finalize a release of OpenSim Creator.
How comprehensively the QA/testing steps are done is entirely dependent on how many changes were made since the last release (assuming an automated test suite isn't available that covers the changes).
Release XX.xx.pp
CMakeLists.txt
(project
)CHANGELOG.md
sections such that the currentunreleased
section becomesXX.xx.pp
and then add a newunreleased
section above thatbump_zenodo_details.py
to automatically do thiscodemeta.json
is up-to-dateCITATION.cff
is up-to-dateREADME.md
is up-to-date