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

doc: release documentation

Browse source
This commit is contained in:
Éloi Rivard 2024-03-29 11:25:15 +01:00
parent 3592b40f03
commit 0fabf4c1a2
No known key found for this signature in database
GPG key ID: 7EDA204EA57DD184
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
CONTRIBUTING.rst
View file

@ -167,3 +167,16 @@ You can also run sphinx by hand, that should be faster since it avoids the tox e
sphinx-build doc build/sphinx/html
The generated documentation is located at ``build/sphinx/html``.
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.
2. Check that tests are still green
3. Check that coverage is still at 100%
4. Check that the :ref:`changelog:Release notes` section is correctly filled up
5. Increase the version number in ``pyproject.toml``
6. Commit with ``git commit``
7. Publish with ``poetry publish --build``
8. Tag you commit with ``git tag XX.YY.ZZ``
9. Push the release commit and the new tag on the repository with ``git push --tags``