-
Notifications
You must be signed in to change notification settings - Fork 21
Release process
Hannes Vogt edited this page Mar 5, 2019
·
8 revisions
GridTools doesn't have a fixed release cycle, but will release important patches and new features as they become available. GridTools uses semantic versioning. TODO define public API.
The following describes the steps for making a GridTools major or minor release, patch releases are described afterwards.
- Ensure that documentation is up-to-date and fix if needed.
- Write release notes (if the gate-keeper did a good job, they items can be taken from the commit messages). TODO: Do we put them as part of the repo or just on github?
- Check if the CMake version number matches the planned release version and update if necessary.
- Compile the documentation and update the github-pages with the new documentation.
- Create the release on Github targeting the current master.
- Branch from the current master and push a branch
branch_vX.Y
from which patch versions can be released. - Update the CMake version number in the
master
branch to the next minor release.
The following describes the steps for making a patch release.
- Cherry-pick a bugfix to the branch
branch_vX.Y
from which a patch release should be made. - Update CMake version number in the branch.
- Write short release notes.
- Create the release on Github targeting the current branch.