New features and bug fixes are continuously added to the develop branch. On
every merge to master, the version number in
be incremented as described below.
For version numbers, we use
Cis increased for bug fixes,
Bis increased for new features and minor API breaking changes,
Ais increased for major API breaking changes.
Creating a new release¶
After new commits have been added to the develop branch, changes can be merged to master and a new version of pyPESTO can be released. Every merge to master should coincide with an incremented version number and a git tag on the respective merge commit.
Merge into master¶
- create a pull request from develop to master
- check that all tests on travis pass
- check that the documentation is up-to-date
- adapt the version number in the file
- update the release notes in
- request a code review
- merge into the origin master branch
To be able to actually perform the merge, sufficient rights may be required. Also, at least one review is required.
Creating a release on github¶
After merging into master, create a new release on Github. In the release form:
- specify a tag with the new version as specified in
pesto/version.py, prefixed with
- include the latest additions to
doc/releasenotes.rstin the release description
Tagging the release commit will automatically trigger deployment of the new version to pypi.