-
Notifications
You must be signed in to change notification settings - Fork 82
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
No changelog update needed for this.
- Loading branch information
Showing
3 changed files
with
44 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
#!/usr/bin/env bash | ||
|
||
set -euo pipefail | ||
|
||
changed_files="$(git diff --name-only origin/main)" | ||
if [[ -z "${changed_files}" ]]; then | ||
exit 0 | ||
fi | ||
|
||
commit_messages="$(git log origin/main..)" | ||
if tr '[:upper:]' '[:lower:]' <<< "${commit_messages}" | \ | ||
tr '\n' ' ' | sed -E 's/[[:space:]]+/ /g' | \ | ||
grep -q "no changelog update needed"; then | ||
exit 0 | ||
fi | ||
|
||
if ! grep -qF CHANGELOG.md <<< "${changed_files}"; then | ||
cat <<"EOF" | ||
<== lint-changelog ==> | ||
Please update the changelog to cover the changes you made. Or, if the | ||
changes don't need to be documented in the changelog, add the text "no | ||
changelog update needed" to one of your commit messages. Line breaks | ||
and case sensitivity do not matter. | ||
Remember, when writing a changelog entry, the idea is a user can use | ||
it to understand what differences they might notice after upgrading to | ||
the new version. So, include enough context for someone who isn't | ||
working directly on the code to understand. If user-visible behavior | ||
hasn't changed since the last release, for example because you're | ||
fixing a bug that was just introduced, then you don't need a changelog | ||
entry. | ||
<== lint-changelog ==> | ||
EOF | ||
echo >&2 "lint-changelog: Please update the changelog to cover the changes you made." | ||
exit 1 | ||
fi |