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

doc: release instructions improvements

Browse source
This commit is contained in:
Éloi Rivard 2024-03-29 12:10:53 +01:00
parent 2d027a6790
commit 9f80792ad0
No known key found for this signature in database
GPG key ID: 7EDA204EA57DD184
1 changed files with 7 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING.rst
View file

@ -172,11 +172,10 @@ Publish a new release
--------------------- ---------------------
1. Check that dependencies are up to date with ``poetry show --outdated --with dev,doc,demo`` and update dependencies accordingly in separated commits. 1. Check that dependencies are up to date with ``poetry show --outdated --with dev,doc,demo`` and update dependencies accordingly in separated commits.
2. Check that tests are still green 2. Check that tests are still green for every supported python version, and that coverage is still at 100%, by running ``tox``
3. Check that coverage is still at 100% 3. Check that the :ref:`changelog:Release notes` section is correctly filled up
4. Check that the :ref:`changelog:Release notes` section is correctly filled up 4. Increase the version number in ``pyproject.toml``
5. Increase the version number in ``pyproject.toml`` 5. Commit with ``git commit``
6. Commit with ``git commit`` 6. Publish with ``poetry publish --build``
7. Publish with ``poetry publish --build`` 7. Tag you commit with ``git tag XX.YY.ZZ``
8. Tag you commit with ``git tag XX.YY.ZZ`` 8. Push the release commit and the new tag on the repository with ``git push --tags``
9. Push the release commit and the new tag on the repository with ``git push --tags``