aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmil Fresk <emil.fresk@gmail.com>2022-01-03 18:37:54 +0100
committerEmil Fresk <emil.fresk@gmail.com>2022-01-03 18:37:54 +0100
commit5d645b13114f6536a9f25570a9df59dfe66e29a6 (patch)
tree073cce3e52daa821f38d6389fe5522838ebb951c
parentf9902681474a8d203a5ba4209d788c30b27f5db5 (diff)
Added changelog enforcer
-rw-r--r--.github/workflows/changelog.yml28
-rw-r--r--CHANGELOG.md4
2 files changed, 32 insertions, 0 deletions
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
new file mode 100644
index 0000000..ccf6eb9
--- /dev/null
+++ b/.github/workflows/changelog.yml
@@ -0,0 +1,28 @@
+# Check that the changelog is updated for all changes.
+#
+# This is only run for PRs.
+
+on:
+ pull_request:
+ # opened, reopened, synchronize are the default types for pull_request.
+ # labeled, unlabeled ensure this check is also run if a label is added or removed.
+ types: [opened, reopened, labeled, unlabeled, synchronize]
+
+name: Changelog
+
+jobs:
+ changelog:
+ name: Changelog
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout sources
+ uses: actions/checkout@v2
+
+ - name: Check that changelog updated
+ uses: dangoslen/changelog-enforcer@v3
+ with:
+ changeLogPath: CHANGELOG.md
+ skipLabels: 'needs-changelog, skip-changelog'
+ missingUpdateErrorMessage: 'Please add a changelog entry in the CHANGELOG.md file.'
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 746f58a..378bd11 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
## [Unreleased]
+### Added
+
+- CI changelog entry enforcer
+
## [v1.0.0] - 2021-12-25
### Changed