Versioning

Philosophy

cortecs generally follows semantic versioning guidelines. In brief, this means that our version numbers follow a AA.BB.CC convention, with AA incrementing when a large, backward-incompatible changes are introduced to the code base; BB incrementing when backward-compatible functionality is added to a code; and CC incrementing whenever backward-compatible bugs are fixed.

Additionally, suffixes (e.g. “-beta” or “-dev”) may be added to the release tag, signifying the degree to which developers are confident in production-ready (i.e., bug-free) code.

In practice

This only applies to developers with write access to the code base. All that needs to be done is:

1. Adjust the version specified in src/cortecs/__init__.py. This will automatically update docs and setup.py configurations.

2. Update the GitHub release version to match the version specified in Step 1. This will automatically publish the build on PyPI.