Release Guide

Making a new release of MDPOW:

On develop

1. make sure that all issues for the mile stone have been addressed
2. finalize CHANGES
   • release date
   • check completeness
3. commit changes to develop and wait for CI to pass

On master

5. merge develop into master

   git checkout master
   git merge develop
   

6. Tag the release on master

   git tag -m "Release X.Y.Z" release-x.y.z
   

7. Push master

   git push
   git push --tags
   

8. Create a release on GitHub from the tagged commit. Add notes, i.e., a condensed summary of CHANGES and typically a link to the CHANGES of the tagged release.

PyPi

For background see the Python Packaging User Guide : Uploading your project to PyPi. Interaction with PyPi is handled by twine (which needs to be installed).

9. Create distribution packages

   python setup.py build sdist bdist_wheel
   

10. Optional: create detached signatures to sign the packages:

    ls dist/MDPOW-*.{tar.gz,whl} | xargs -I% gpg --detach-sign -a %
    

11. Check

    twine check dist/*
    

12. Upload distribution to PyPi

    twine upload dist/*
    

Finalize

12. Close milestone on GitHub
13. On develop, bump release in version.py and add next entry to CHANGES.