Merge pull request #178 from geotribu/doc/packaging

Doc: packaging
geotribu · Jun 24, 2024 · 7cbd20f · 7cbd20f
2 parents ad77c59 + a505350
commit 7cbd20f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/docs/development/packaging.md b/docs/development/packaging.md
@@ -16,7 +16,11 @@ qgis-plugin-ci package latest
 
 Everything is done through the continuous deployment:
 
-1. Add the new version to the `CHANGELOG.md`
-1. Change the version number in `__about__.py`
+1. Add the new version to the `CHANGELOG.md`. You can write it manually or use the auto-generated release notes by Github:
+    1. Go to [project's releases](https://github.com/geotribu/qtribu/releases) and click on `Draft a new release`
+    1. In `Choose a tag`, enter the new tag
+    1. Click on `Generate release notes`
+    1. Copy/paste the generated text from `## What's changed` until the line before `**Full changelog**:...` in the CHANGELOG.md replacing `What's changed` with the tag and the publication date
+1. Change the version number in `metadata.txt`
 1. Apply a git tag with the relevant version: `git tag -a 0.3.0 {git commit hash} -m "This version rocks!"`
 1. Push tag to main branch: `git push origin 0.3.0`
diff --git a/requirements/documentation.txt b/requirements/documentation.txt
@@ -2,7 +2,7 @@
 # -----------------------
 
 myst-parser[linkify]>=2
-sphinx-autobuild>=2021.*
+sphinx-autobuild>=2024
 sphinx-autodoc-typehints>=1.25
 sphinx-copybutton>=0.5,<1
 sphinxext-opengraph>=0.7