diff options
| author | Lars-Dominik Braun <lars@6xq.net> | 2019-07-04 13:53:30 +0200 |
|---|---|---|
| committer | Lars-Dominik Braun <lars@6xq.net> | 2019-07-04 13:53:30 +0200 |
| commit | 799c79638b9bdebd7d04c524a2dd6e8779057679 (patch) | |
| tree | 5ab5f8250cc771838e4f9de2fe3ea2d9411fd78b /doc/develop.rst | |
| parent | e7eb6fcd4781a907bf698a88df9cb34b5b31c369 (diff) | |
| download | crocoite-799c79638b9bdebd7d04c524a2dd6e8779057679.tar.gz crocoite-799c79638b9bdebd7d04c524a2dd6e8779057679.tar.bz2 crocoite-799c79638b9bdebd7d04c524a2dd6e8779057679.zip | |
Update documentation
Re-arrange stuff, add release guide. Needs a lot more work though.
Diffstat (limited to 'doc/develop.rst')
| -rw-r--r-- | doc/develop.rst | 24 |
1 files changed, 24 insertions, 0 deletions
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 + |