Add changelog workflow

stephane-caron · stephane-caron · commit 4405deae23c4 · 2024-10-29T17:33:20.000+01:00
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -0,0 +1,21 @@
+name: Changelog
+
+on:
+    pull_request:
+        branches: [ main ]
+
+jobs:
+    changelog:
+        name: "Check changelog update"
+        runs-on: ubuntu-latest
+        steps:
+            - uses: tarides/changelog-check-action@v2
+              with:
+                  changelog: CHANGELOG.md
+
+    changelog_success:
+        name: "Changelog success"
+        runs-on: ubuntu-latest
+        needs: [changelog]
+        steps:
+            - run: echo "Changelog workflow completed successfully"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- CICD: CI workflow
+- CICD: Changelog workflow
+- Complete API documentation
+
+### Fixed
+
+- Clean up dead code
+- Correct type annotations
+- Update `resources.path` to `resources.files`
+
 ## [1.0.0] - 2024-10-29
 
 - Extract this project from [foxplot](https://github.com/stephane-caron/foxplot)
