How to release

This is a guide on how to publish and ship a new release of the windpowerlib.

Before release

1. Check setup.py
   1. Version correct?
   2. Version of depending packages: Are lower and upper limits correct? Are new versions included?
2. Update version number in __init__ file
3. Make sure desired changes (PRs) are merged to dev
4. Check docs
   1. Build docs locally sphinx-build -b html path/to/doc/ output/path/
   2. Remove errors and warnings as far as possible
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 issues attached to the milestone that were closed.
6. README
   1. Last check on README file because it will be the first page on PyPi
   2. Check the rendering of the README file. a) pip install readme_renderer b) python setup.py check -r -s c) If errors occur fix them now and check again (b). It is NOT possible to fix them after the release.

Actual release process

1. Merge dev to master
2. Check the rendering of the README file on the master python setup.py check -r -s
3. Create a release tag on master.
4. Pull master to your local repository and check if the new tag is there.
5. Release via PyPI (this link may be helpful).
   1. The upload requires a ~/.pypirc file with your PyPI credentials.
   2. Make sure you are in master branch and the latest commit.
   3. Use python setup.py register sdist upload to register and upload package to PyPI.

After the release

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