From fc5e78605b98c4f9420ff89af9cab3df3b16de0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Sampaio?= Date: Mon, 12 Apr 2021 17:33:50 -0300 Subject: [PATCH] Document release process (#192) [skip ci] --- README.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.rst b/README.rst index add54a1b..7ec3c37d 100644 --- a/README.rst +++ b/README.rst @@ -786,3 +786,14 @@ Tests can be more granularly run using normal pytest flags. For example: .. code :: bash docker-compose run --rm tasktiger pytest tests/test_base.py::TestCase + + +Releasing a New Version +----------------------- + +#. Make sure the code has been thoroughly reviewed and tested in a realistic production environment. +#. Update ``setup.py`` and ``CHANGELOG.md``. Make sure you include any breaking changes. +#. Run ``python setup.py sdist`` and ``twine upload dist/``. +#. Push a new tag pointing to the released commit, format: ``v0.13`` for example. +#. Mark the tag as a release in GitHub's UI and include in the description the changelog entry for the version. + An example would be: https://github.com/closeio/tasktiger/releases/tag/v0.13.