Skip to content

Commit 601f379

Browse files
committed
chore: enforce changelogs must be in changelogs/ directory
1 parent 369d55b commit 601f379

2 files changed

Lines changed: 25 additions & 3 deletions

File tree

.github/workflows/require-changelog.yml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,26 @@ jobs:
3434
exit 0
3535
fi
3636
37+
# Reject changelogs placed in repo root instead of changelogs/
38+
ROOT_CHANGELOG=$(echo "$FILES" | grep -E '^CHANGELOG-.*\.md$' || true)
39+
if [ -n "$ROOT_CHANGELOG" ]; then
40+
echo ""
41+
echo "❌ FAILED: Changelog found in repo root — must be in changelogs/ directory."
42+
echo " Found: $ROOT_CHANGELOG"
43+
echo " Move it: git mv $ROOT_CHANGELOG changelogs/"
44+
echo ""
45+
exit 1
46+
fi
47+
3748
# Check for CHANGELOG file in changelogs/ directory
3849
CHANGELOG=$(echo "$FILES" | grep -E '^changelogs/CHANGELOG-.*\.md$' || true)
3950
4051
if [ -z "$CHANGELOG" ]; then
4152
echo ""
42-
echo "❌ FAILED: No CHANGELOG-*.md file found in this commit."
53+
echo "❌ FAILED: No changelog found in changelogs/ directory."
4354
echo ""
44-
echo "Every commit with code changes must include a CHANGELOG-<topic>.md file"
45-
echo "documenting what was changed."
55+
echo "Every commit with code changes must include a changelogs/CHANGELOG-<topic>.md file."
56+
echo "Example: changelogs/CHANGELOG-my-feature.md"
4657
echo ""
4758
exit 1
4859
fi
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CHANGELOG — Enforce Changelogs in changelogs/ Directory
2+
3+
## Summary
4+
Updated the GitHub Action to reject changelogs placed in the repo root and require them in `changelogs/`.
5+
6+
## What Changed
7+
8+
### `.github/workflows/require-changelog.yml`
9+
- Added check: rejects any `CHANGELOG-*.md` file found in repo root with helpful move command
10+
- Updated error messages to reference `changelogs/CHANGELOG-<topic>.md` path
11+
- Existing check for `changelogs/CHANGELOG-*.md` unchanged

0 commit comments

Comments
 (0)