Skip to content

Commit

Permalink
Document release process (#192) [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmelos committed Apr 12, 2021
1 parent 3821283 commit fc5e786
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.rst
Expand Up @@ -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/<PACKAGE_TO_UPLOAD>``.
#. 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.

0 comments on commit fc5e786

Please sign in to comment.