How to release

This is quick on how to publish and ship a new release of eDisGo.

Before release

1. Check setup.py
   1. Version correct?
   2. Version of depending packages: Are lower and upper limit are correct? Are new versions included? Are all upper version bounds in line with dependencies of eTraGo and eGo?
2. Update version number in conf.py
3. Make sure desired changes (PRs) are merged to dev
4. Check docs
   1. Build docs locally
   2. Remove errors and warnings as far as possible
   3. Check HTML build
5. What's new
   1. Set release date in "What's new"
   2. Make sure list of changes, bug fixes and new features is complete. Consider to scan issue attached to the milestone that were closed
   3. Add latest "What's new" to What's new documentation

Actual release process

1. Create a PR from dev to master
2. Let a reviewer merge it or merge it yourself
3. Create a release tag on master. Preferably, use GitHub for that.
4. Pull master to your local repository (incl. new tag)
5. Release via PyPI (if you don't have permissions for this repo, ask someone who does)
   1. The upload requires a ~/.pypirc file with your PyPI credentials.
   2. Make sure you are in master branch.
   3. Use python3 setup.py register sdist upload to register and upload package to PyPI.

After the release

1. Set version for next release in setup.py of dev
2. Create "What's new" file for next version
3. Celebrate! 🎆 🍾 👏