Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.33 KB

RELEASE_INSTRUCTIONS.md

File metadata and controls

44 lines (29 loc) · 1.33 KB
Raw

Naming convention

Our naming convention is as follows:

<major>.<minor>.<micro>.<qualifier>

Branching

All of our development occurs in the master branch. Once our features are mature enough, we create a maintenance branch with the format 'pnc-..x'. When this is done, the repour version in the master branch in file repour/__init__.py should be bumped to the next major/minor release.

Release Instructions

When we are ready to release Repour, the following instructions have to be followed:

  1. Update the changelog file with the current version in the notes

  2. Update the file repour/__init__.py inside our git maintenance branch for the version. The qualifier should be set to 'FINAL' and not 'SNAPSHOT'.

    Also update the pyproject.toml

  3. Update the Changelog with the correct version + release date

  4. Commit the changes and push to upstream git repository

  5. Create a tag with format 'pnc-..' and push to upstream git repository

  6. Change the file repour/__init__.py again to increase the micro version by one, and change the qualifier to 'SNAPSHOT'. Don't forget to commit and push those changes

Version

When we do a release, the version changes from qualifier 'SNAPSHOT' to 'FINAL'

While developing for the next version, the version qualifier should be 'SNAPSHOT'