docs: improve release documentation

This commit is contained in:
Matthias 2024-08-31 08:34:48 +02:00
parent a881d3fd81
commit 7edc50865f

View File

@ -481,21 +481,24 @@ Once the PR against stable is merged (best right after merging):
### pypi
!!! Note
This process is now automated as part of Github Actions.
!!! Warning "Manual Releases"
This process is automated as part of Github Actions.
Manual pypi pushes should not be necessary.
To create a pypi release, please run the following commands:
??? example "Manual release"
To manually create a pypi release, please run the following commands:
Additional requirement: `wheel`, `twine` (for uploading), account on pypi with proper permissions.
Additional requirement: `wheel`, `twine` (for uploading), account on pypi with proper permissions.
``` bash
python setup.py sdist bdist_wheel
``` bash
pip install -U build
python -m build --sdist --wheel
# For pypi test (to check if some change to the installation did work)
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
# For pypi test (to check if some change to the installation did work)
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
# For production:
twine upload dist/*
```
# For production:
twine upload dist/*
```
Please don't push non-releases to the productive / real pypi instance.
Please don't push non-releases to the productive / real pypi instance.