Skip to content

ci: Check CHANGELOG.md against the Keep a Changelog format #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tablackburn merged 2 commits into from
Aug 28, 2026
Merged

ci: Check CHANGELOG.md against the Keep a Changelog format #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f448a85
ci: Check CHANGELOG.md against the Keep a Changelog format
tablackburn Aug 28, 2026
8f39948
ci: Validate CHANGELOG.md against the Keep a Changelog format
tablackburn Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/workflows/ModuleCI.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,17 @@ jobs:
runs-on: [ubuntu-latest]
steps:
- uses: actions/checkout@v4
# Validates CHANGELOG.md against the Keep a Changelog format. Skipped when the
# repository has no changelog, so a consumer without one is not failed for it.
# validation_depth defaults to 10 entries; raised so older releases are checked
# too, which is where format drift accumulates unnoticed.
- name: Validate changelog (keepachangelog)
if: hashFiles('CHANGELOG.md') != ''
uses: mindsers/changelog-reader-action@v2
with:
validation_level: error
validation_depth: 100
path: ./CHANGELOG.md
- uses: streetsidesoftware/cspell-action@v6
with:
strict: false
Expand Down