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 OSC on Linux with:
-DCMAKE_BUILD_TYPE=Debug (incl. for Simbody+OpenSim)
CC=clang CXX=clang++ CCFLAGS=-fsanitize=address CXXFLAGS=-fsanitize=address (incl. for Simbody+OpenSim)
-DOSC_FORCE_ASSERTS_ENABLED=ON
-DOSC_FORCE_UNDEFINE_NDEBUG=ON
[x] Ensure test suite passes with debug+ASAN build
[x] Manually spot-check new changes with debug+ASAN build
[x] Go through manual QA process (list below)
How comprehensively you do this is subjective
[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 codemeta.json with latest Zenodo release details
[x] Update CITATION.cff with latest Zenodo release details
[x] Update README.md with latest Zenodo release details (CITING)
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.ppCMakeLists.txt(project)-DCMAKE_BUILD_TYPE=Debug(incl. for Simbody+OpenSim)CC=clang CXX=clang++ CCFLAGS=-fsanitize=address CXXFLAGS=-fsanitize=address(incl. for Simbody+OpenSim)-DOSC_FORCE_ASSERTS_ENABLED=ON-DOSC_FORCE_UNDEFINE_NDEBUG=ONCHANGELOG.mdsections such that the currentunreleasedsection becomesXX.xx.ppand then add a newunreleasedsection above thatcodemeta.jsonwith latest Zenodo release detailsCITATION.cffwith latest Zenodo release detailsREADME.mdwith latest Zenodo release details (CITING)Manual QA Checklist
(mostly skipped: this is a small release)