Releasing a new version#
Most of the process related to releasing a new version of cotainr is automated. However a few things, as detailed on this page, must still be done to initiate the release process.
Versioning scheme#
A CalVer versioning scheme is used for cotainr, more specifically:
YYYY.MM.MINOR
with:
YYYY
- full year - 2022, 2023, …MM
- short month - 1, 2 … 11, 12MINOR
- zero-indexed counter specific toYYYY.MM
- 0, 1, … - incremented for each version released in a given year/month.
Release process#
In order to release a new version of cotainr, one must:
Update the
cotainr.__version__
string in cotianr/__init__.py.Update the version switcher list by running the doc/create_switcher.py script.
Create the associated release notes, i.e. create a YYYY.MM.MINOR.md file in the doc/release_notes folder based on the template doc/release_notes/release_note.md.template.
Update the project README.md with new version in EasyBuild script (and possibly new system.json content).
Create a git tag (
git tag YYYY.MM.MINOR
) for the version on the main branch and push it to the GitHub repository.Assert that the CD setup finishes correctly.