Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.45 KB

CONTRIBUTING.rst

File metadata and controls

50 lines (31 loc) · 1.45 KB
Raw

How to contribute

Development happens on GitHub - bug reports and pull requests welcome!

Tagging a new version

dokuwikixmlrpc uses date based versioning. To release a version with today's date, follow these steps. :

VERSION=$(date +%Y.%m.%d)

To simplify updating the version number consistently across different files and creating the appropriate annotated tag, we use bump2version. For the first new release in a year, run :

bump2version --new-version $VERSION major

and for subsequent releases :

bump2version --new-version $VERSION minor

Remember to also push the release tag with git push --tags.

Packaging and releasing on PyPI

Build the source distribution and wheel using build: :

python -m build

Use twine to verify and upload the new release to PyPI. :

twine check dist/dokuwikixmlrpc-${VERSION}*

Then upload to test PyPI first: :

twine upload -r testpypi dist/dokuwikixmlrpc-${VERSION}*

If everything looks sane, upload to the "real" PyPI: :

twine upload dist/dokuwikixmlrpc-${VERSION}*