diff options
| author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2020-10-08 20:44:39 +0200 |
|---|---|---|
| committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2020-10-08 20:44:39 +0200 |
| commit | 83606e28d559c1ca4928b08aa4c050872e806cfa (patch) | |
| tree | d2e6577f2d384faf63dc48587d6d51c1ad0eca22 | |
| parent | 54185616ef81fa1da57b3d3bad4d9f5f71c0b07c (diff) | |
Contrib documentation: release procedure
| -rw-r--r-- | docs/source/contrib/index.rst | 1 | ||||
| -rw-r--r-- | docs/source/contrib/release_procedure.rst | 22 |
2 files changed, 23 insertions, 0 deletions
diff --git a/docs/source/contrib/index.rst b/docs/source/contrib/index.rst index 70d1e1c..e536cf3 100644 --- a/docs/source/contrib/index.rst +++ b/docs/source/contrib/index.rst @@ -8,3 +8,4 @@ Documentation that is useful for contributors of lesana. :maxdepth: 2 :caption: Contents: + release_procedure diff --git a/docs/source/contrib/release_procedure.rst b/docs/source/contrib/release_procedure.rst new file mode 100644 index 0000000..f54ed9f --- /dev/null +++ b/docs/source/contrib/release_procedure.rst @@ -0,0 +1,22 @@ +******************* + Release procedure +******************* + +* Check that the version number in setup.py is correct. + +* Check that the changelog is up to date. + +* Generate the distribution files:: + + $ python3 setup.py sdist bdist_wheel + +* Upload :: + + $ twine upload -s dist/* + +* Tag the uploaded version:: + + $ git tag -s v$VERSION -m "Version $VERSION" + $ git push + $ git push --tags + |