globuzma/canaille-globuzma
1
0
Fork 0
forked from Github-Mirrors/canaille
Code Pull requests Activity

doc: release instructions

Browse source
This commit is contained in:
Éloi Rivard 2024-11-13 10:04:58 +01:00
parent 9d2fbfdcbf
commit c0b6fa358c
No known key found for this signature in database
GPG key ID: 7EDA204EA57DD184
1 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
CONTRIBUTING.rst
View file

@ -178,15 +178,15 @@ The generated documentation is located at ``build/sphinx/html``.
Publish a new release Publish a new release
--------------------- ---------------------
1. Check that dependencies are up to date with ``uv sync --upgrade`` and update dependencies accordingly in separated commits. 1. Check that dependencies are up to date with ``uv sync --upgrade`` and update dependencies accordingly in separated commits;
2. Check that tests are still green for every supported python version, and that coverage is still at 100%, by running ``uv run tox`` 2. Check that tests are still green for every supported python version, and that coverage is still at 100%, by running ``uv run tox``;
3. Check that the demo environments are still working 3. Check that the demo environments are still working, both the local and the Docker one;
4. Check that the :ref:`development/changelog:Release notes` section is correctly filled up 4. Check that the :ref:`development/changelog:Release notes` section is correctly filled up;
5. Increase the version number in ``pyproject.toml`` 5. Increase the version number in ``pyproject.toml``;
6. Commit with ``git commit`` 6. Commit with ``git commit``;
7. Build with ``uv build`` 7. Build with ``uv build``;
8. Publish on test PyPI with ``uv publish --publish-url https://test.pypi.org/legacy/`` 8. Publish on test PyPI with ``uv publish --publish-url https://test.pypi.org/legacy/``;
9. Install the test package somewhere with ``pip install --extra-index-url https://test.pypi.org/simple --upgrade canaille``. Check that everything looks fine. 9. Install the test package somewhere with ``pip install --extra-index-url https://test.pypi.org/simple --upgrade canaille``. Check that everything looks fine;
10. Publish on production PyPI ``uv publish`` 10. Publish on production PyPI ``uv publish``;
11. Tag you commit with ``git tag XX.YY.ZZ`` 11. Tag the commit with ``git tag XX.YY.ZZ``;
12. Push the release commit and the new tag on the repository with ``git push --tags`` 12. Push the release commit and the new tag on the repository with ``git push --tags``.