RELEASING.rst

Releasing popparsing

When releasing a new version of popparsing:

1. git pull to make sure you haven't missed any last-minute commits. After this point, nothing else is making it into this version.
2. Ensure that all tests pass locally on develop.
3. Regenerate the API documentation with sphinx-apidoc -f -o docs/api/ popparsing/ -H 'API Documentation'.
4. Resolve differences and commit the updated API documentation.
5. git push and verify all tests pass on all CI services.
6. Generate a list of commits since the last version with git log --oneline --no-decorate 0.1^..origin/master Replace 0.1 with the tag of the last public version.
7. Condense the change list into something user-readable. Update and commit CHANGES.rst with the release date.``
8. git tag 0.2 master -m "0.2" Replace 0.2 with the new version. git show 0.2 to ensure the correct commit was tagged git push origin master --tags
9. The new version is tagged in the repository. Now the public package must be built and distributed.

Uploading to PyPI

1. rm -R dist/* on Linux/OSX or del dist/* on Windows

2. With the commit checked out which was tagged with the new version: python setup.py sdist

   Make sure that the script correctly detected the new version exactly and not a dirty / revised state of the repo.

   Assuming a correctly configured .pypirc:

   twine upload -r pypi -u bocklund dist/*