use snippets2changelog

.github/workflows/release.yml

@@ -27,6 +27,12 @@ jobs:
           python -m pip install -U setuptools wheel build
           if [ -f requirements-deploy.txt ]; then pip install -r requirements-deploy.txt; fi
           pip install .
+      - name: Update changelog with snippets
+        run: |
+          changelog-generator \
+            changelog changelog.md \
+            --snippets=.snippets \
+            --in-place
       - name: Parse changelog
         id: parse_changelog
         run: |

.github/workflows/test-release.yaml

@@ -24,6 +24,12 @@ jobs:
           python -m pip install -U setuptools wheel build
           if [ -f requirements-deploy.txt ]; then pip install -r requirements-deploy.txt; fi
           pip install .
+      - name: Update changelog with snippets
+        run: |
+          changelog-generator \
+            changelog changelog.md \
+            --snippets=.snippets \
+            --in-place
       - name: Parse changelog
         id: parse_changelog
         run: |

.github/workflows/test.yml

@@ -43,6 +43,12 @@ jobs:
           python -m pip install -U setuptools wheel build
           if [ -f requirements-deploy.txt ]; then pip install -r requirements-deploy.txt; fi
           pip install .
+      - name: Update changelog with snippets
+        run: |
+          changelog-generator \
+            changelog changelog.md \
+            --snippets=.snippets \
+            --in-place
       - name: Build package
         run: |
           changelog2version \

.snippets/26.md

@@ -0,0 +1,12 @@
+## Use snippets2changelog
+<!--
+type: feature
+scope: all
+affected: all
+-->
+
+- run isort on all files
+- drop Python 3.8 support everywhere and update README badge
+- add generated `changelog.json` file to `.gitignore`
+- use latest `actions/checkout@v4` and `actions/setup-python@v5`
+- use `snippets2changelog` package, closes #26

requirements-deploy.txt

@@ -2,3 +2,4 @@
 # Avoid fixed versions
 # # to upload package to PyPi or other package hosts
 twine>=5.1.1,<6
+snippets2changelog>=1.2.1,<2