diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5eeb4c6050ac5dc52743886b4bdb071bb3548d60..37de4ccafc9529243c5144286bf4633631ce607e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -121,6 +121,19 @@ To create a release, we use following script which will update the version in di Then, a `git push --tags` is necessary to publish the tag. Git could be configured to publish tags with a simple `push`. +### How to release a pre-release on PyPI +[Append `[{a|b|rc}N]` to the version, it will be automatically detected as pre-release by PyPI](https://pythonpackaging.info/07-Package-Release.html). i.e.: `v0.10.0rc0`. +- install a pre-release from PyPI: + +```sh +pip install silkaj --user --upgrade --pre +``` +- install `silkaj` from PyPI test and the dependencies (i.e. DuniterPy) from PyPI (have been removed from the documentation): + +```sh +pip install silkaj --user --upgrade -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ +``` + ### Update copyright year Follow [this documentation](https://github.com/Lucas-C/pre-commit-hooks#removing-old-license-and-replacing-it-with-a-new-one) Only difference is to update the year in `license_header.txt` rather than `LICENSE.txt`.