|
| 1 | +#!/usr/bin/env bash |
| 2 | +# Verify CHANGELOG.md hygiene in pull requests: |
| 3 | +# 1. CHANGELOG.md changes must be in their own dedicated commit |
| 4 | +# 2. Commit hashes referenced in new changelog entries must exist |
| 5 | +# in the branch |
| 6 | +# 3. Commit link URLs must match their reference keys |
| 7 | +# |
| 8 | +# Usage: check-changelog-commit.sh <base-sha> |
| 9 | +set -euo pipefail |
| 10 | + |
| 11 | +base="${1:?Usage: check-changelog-commit.sh <base-sha>}" |
| 12 | +errors=0 |
| 13 | + |
| 14 | +# --- Check 1: CHANGELOG.md must be in dedicated commits --- |
| 15 | + |
| 16 | +for commit in $(git log --format=%H "${base}..HEAD"); do |
| 17 | + files=$(git diff-tree --no-commit-id --name-only -r "$commit") |
| 18 | + if echo "$files" | grep -q "^CHANGELOG.md$"; then |
| 19 | + file_count=$(echo "$files" | wc -l | tr -d ' ') |
| 20 | + if [ "$file_count" -gt 1 ]; then |
| 21 | + echo "::error::Commit $commit modifies CHANGELOG.md alongside other files." |
| 22 | + echo "CHANGELOG.md changes must be in their own dedicated commit." |
| 23 | + errors=$((errors + 1)) |
| 24 | + fi |
| 25 | + fi |
| 26 | +done |
| 27 | + |
| 28 | +# --- Check 2: Referenced commit hashes must exist in the branch --- |
| 29 | + |
| 30 | +# Get new changelog lines added in this PR |
| 31 | +changelog_diff=$(git diff "${base}..HEAD" -- CHANGELOG.md \ |
| 32 | + | grep "^+" | grep -v "^+++" || true) |
| 33 | + |
| 34 | +# Extract short commit hashes from inline references like ([abc1234], ...) |
| 35 | +inline_hashes=$(echo "$changelog_diff" \ |
| 36 | + | grep -oE '\(\[([0-9a-f]{7,})\]' \ |
| 37 | + | grep -oE '[0-9a-f]{7,}' | sort -u || true) |
| 38 | + |
| 39 | +# Get all commits reachable from HEAD (not just this branch) |
| 40 | +for hash in $inline_hashes; do |
| 41 | + if ! git cat-file -t "$hash" >/dev/null 2>&1; then |
| 42 | + echo "::error::Commit $hash referenced in CHANGELOG.md does not exist." |
| 43 | + errors=$((errors + 1)) |
| 44 | + fi |
| 45 | +done |
| 46 | + |
| 47 | +# --- Check 3: Link definition URLs must match their keys --- |
| 48 | +# Matches lines like: [abc1234]: https://.../commit/xyz7890 |
| 49 | +# and verifies abc1234 == xyz7890 |
| 50 | + |
| 51 | +link_lines=$(echo "$changelog_diff" \ |
| 52 | + | grep -E '^\+\[[0-9a-f]{7,}\]: https://.*commit/' || true) |
| 53 | + |
| 54 | +while IFS= read -r line; do |
| 55 | + [ -z "$line" ] && continue |
| 56 | + key=$(echo "$line" \ |
| 57 | + | grep -oE '\[([0-9a-f]{7,})\]' | head -1 \ |
| 58 | + | tr -d '[]') |
| 59 | + url_hash=$(echo "$line" \ |
| 60 | + | grep -oE 'commit/[0-9a-f]{7,}' \ |
| 61 | + | sed 's|commit/||') |
| 62 | + if [ -n "$key" ] && [ -n "$url_hash" ] && [ "$key" != "$url_hash" ]; then |
| 63 | + echo "::error::Link [$key] points to commit/$url_hash but should point to commit/$key" |
| 64 | + errors=$((errors + 1)) |
| 65 | + fi |
| 66 | +done <<< "$link_lines" |
| 67 | + |
| 68 | +# --- Summary --- |
| 69 | + |
| 70 | +if [ "$errors" -gt 0 ]; then |
| 71 | + echo "Found $errors changelog error(s)." |
| 72 | + exit 1 |
| 73 | +fi |
| 74 | + |
| 75 | +echo "All changelog checks passed." |
0 commit comments