image:https://github.com/Zomzog/changelog-checker/workflows/build/badge.svg["build"] image:https://david-dm.org/Zomzog/changelog-checker.svg["david"] image:https://snyk.io/test/github/Zomzog/changelog-checker/badge.svg?targetFile=package.json["Known Vulnerabilities", link="https://snyk.io/test/github/Zomzog/changelog-checker?targetFile=package.json"]
=== Why
This action will check that the changelog file has been updated in the PR. It will add a check on the PR which can be required for blocking the merge.
The changelog file name can be customized with fileName
parameter.
The check can be disabled for a PR with a label.
This label can be customized with the noChangelogLabel
parameter.
The checkNotification
allows switching between Simple and Detailed checks.
The simple check is based on the default check of the action.
The detailed check will create a second check with a more precise message,
but it required write access so it does not work with forks.
Detailed check fallback to simple for forks.
=== Usage:
CHANGELOG.adoc
no changelog
Detailed
=== Develop
=== Publish to a distribution branch
Actions are run from GitHub repos so we will checkin the packed dist folder.
Your action is now published! 🚀