diff --git a/RELEASE.rst b/RELEASE.rst new file mode 100644 index 00000000..b139e969 --- /dev/null +++ b/RELEASE.rst @@ -0,0 +1,28 @@ +Things to do when releasing a new version +========================================= + +This file is a memo for the maintainer. + + +1. Release +---------- + +* Update version number in ``setup.py`` +* Update version number in ``rivalcfg/version.py`` +* Edit / update changelog in ``README.rst`` +* Commit / tag (``git commit -m vX.Y.Z && git tag vX.Y.Z && git push && git push --tags``) + + +2. Publish PyPI package +----------------------- + +Publish source dist and wheels on PyPI. + +→ Automated :) + + +3. Publish Github Release +~~~~~~~~~~~~~~~~~~~~~~~~~ + +* Make a release on Github +* Add changelog