From 799c79638b9bdebd7d04c524a2dd6e8779057679 Mon Sep 17 00:00:00 2001 From: Lars-Dominik Braun Date: Thu, 4 Jul 2019 13:53:30 +0200 Subject: Update documentation Re-arrange stuff, add release guide. Needs a lot more work though. --- doc/develop.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'doc/develop.rst') diff --git a/doc/develop.rst b/doc/develop.rst index 0113c92..8a8e8bd 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -15,3 +15,27 @@ console. .. _devtools module: crocoite/devtools.py +Release guide +^^^^^^^^^^^^^ + +crocoite uses `semantic versioning`_. To create a new release, bump the version +number in ``setup.py`` according to the linked guide, create distribution +packages:: + + python setup.py sdist bdist_wheel + +Verify them:: + + twine check dist/* + +Try to install and use them in a separate sandbox. And finally sign and upload +a new version to pypi_:: + + gpg --detach-sign --armor dist/*.tar.gz + twine upload dist/* + +Then update the documentation using ``sphing-doc`` and upload it as well. + +.. _semantic versioning: https://semver.org/spec/v2.0.0.html +.. _pypi: https://pypi.org + -- cgit v1.2.3