Skip to content

Handle empty changes #2

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

Open
linhcrl wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Handle empty changes #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2e4f82
Fix base-ref handling in changelog-check diff mode
linhcrl Mar 23, 2026
0df75d4
Prepare v0.1.0 release
linhcrl Mar 23, 2026
b403849
Handle empty CHANGELOG diff in breaking change check
linhcrl Mar 23, 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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Breaking changes are prefixed with "Breaking Change: ".

## [Unreleased]

## [0.1.0] - 2026-03-23

### Added

- `release-version-extract` action: extracts current version and determines next
Expand Down
14 changes: 7 additions & 7 deletions autotag-from-changelog/auto-tag-release_test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ run_test() {
TMPDIR=$(mktemp -d)
trap 'rm -rf "$TMPDIR"' EXIT

git config user.email >/dev/null 2>&1 || git config --global user.email "test@test.com"
git config user.name >/dev/null 2>&1 || git config --global user.name "test"
git init --bare --initial-branch=main "$TMPDIR/origin.git" >/dev/null
git clone "$TMPDIR/origin.git" "$TMPDIR/work" >/dev/null
git config user.email || git config --global user.email "test@test.com"
git config user.name || git config --global user.name "test"
git init --bare --initial-branch=main "$TMPDIR/origin.git"
git clone "$TMPDIR/origin.git" "$TMPDIR/work"
cd "$TMPDIR/work"
git commit --allow-empty -m "initial" >/dev/null
git push origin main >/dev/null
git commit --allow-empty -m "initial"
git push origin main

# =============================================
# parse_changelog unit tests
Expand Down Expand Up @@ -181,7 +181,7 @@ run_test "creates new tag" 0 "Tagged v1.0.0 successfully" \
env CHANGELOG_PATH=CHANGELOG.md "$SCRIPT_DIR/auto-tag-release.sh"

# Verify the tag was actually created
if git rev-parse v1.0.0 >/dev/null 2>&1; then
if git rev-parse v1.0.0; then
echo "PASS: tag v1.0.0 exists"
PASS=$((PASS + 1))
else
Expand Down
3 changes: 2 additions & 1 deletion changelog-check/check_breaking_changes.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ unreleased_content="${UNRELEASED_CONTENT:-}"
if [ "$check_mode" = "diff" ] && [ -n "$base_ref" ]; then
log_notice "Diff mode: checking changelog changes only"
# Get diff, filter to additions, remove file header, strip leading +
text_to_check=$(git diff "$base_ref" HEAD -- "$changelog" | grep "^+" | grep --invert-match "^+++" | sed 's/^+//')
# || true prevents script failure when CHANGELOG is unchanged (grep exits 1 on no matches)
text_to_check=$(git diff "origin/$base_ref" HEAD -- "$changelog" | grep "^+" | grep --invert-match "^+++" | sed 's/^+//' || true)
else
log_notice "Checking entire Unreleased section"
# Use the Unreleased section content from mindsers action
Expand Down
70 changes: 46 additions & 24 deletions changelog-check/check_breaking_changes_test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ expect_success "unreleased mode: Removed section with other sections" test_remov
# =============================================

# Initialize git repo for diff tests
git init > /dev/null 2>&1
git init
git config user.email "test@example.com"
git config user.name "Test User"

Expand All @@ -131,15 +131,15 @@ cat <<'EOF' > CHANGELOG.md
EOF

git add CHANGELOG.md
git commit -m "Initial commit" > /dev/null 2>&1
git commit -m "Initial commit"
git branch -M main

# Set up origin remote and fetch to create tracking branch (simulates production)
git remote add origin . > /dev/null 2>&1
git fetch origin > /dev/null 2>&1
git remote add origin .
git fetch origin

# Create a feature branch
git checkout -b feature-branch > /dev/null 2>&1
git checkout -b feature-branch

# --- Diff mode: Add non-breaking change ---
# This creates a diff with only + lines for non-breaking content
Expand All @@ -159,7 +159,7 @@ cat <<'EOF' > CHANGELOG.md
EOF

git add CHANGELOG.md
git commit -m "Add non-breaking feature" > /dev/null 2>&1
git commit -m "Add non-breaking feature"

# Verify what the diff looks like (for test clarity)
# git diff main HEAD -- CHANGELOG.md should show:
Expand Down Expand Up @@ -196,7 +196,7 @@ cat <<'EOF' > CHANGELOG.md
EOF

git add CHANGELOG.md
git commit -m "Add breaking change" > /dev/null 2>&1
git commit -m "Add breaking change"

# Verify what the diff looks like (for test clarity)
# git diff main HEAD -- CHANGELOG.md should show:
Expand All @@ -217,7 +217,7 @@ expect_success "diff mode: breaking change in additions" test_diff_has_breaking

# --- Diff mode: Breaking change exists in base, not in PR diff ---
# Reset to a state where main has a breaking change
git checkout main > /dev/null 2>&1
git checkout main
cat <<'EOF' > CHANGELOG.md
# Changelog

Expand All @@ -236,11 +236,11 @@ cat <<'EOF' > CHANGELOG.md
EOF

git add CHANGELOG.md
git commit -m "Add breaking change to main" > /dev/null 2>&1
git fetch origin > /dev/null 2>&1
git commit -m "Add breaking change to main"
git fetch origin

# Create new feature branch from updated main
git checkout -b feature-no-breaking > /dev/null 2>&1
git checkout -b feature-no-breaking

# Add only non-breaking content
cat <<'EOF' > CHANGELOG.md
Expand All @@ -262,7 +262,7 @@ cat <<'EOF' > CHANGELOG.md
EOF

git add CHANGELOG.md
git commit -m "Add non-breaking feature to PR" > /dev/null 2>&1
git commit -m "Add non-breaking feature to PR"

# The diff from main should only show:
# +- PR adds this non-breaking feature
Expand All @@ -279,7 +279,7 @@ test_diff_breaking_in_base_not_in_pr() {
expect_success "diff mode: breaking change in base but not in PR additions" test_diff_breaking_in_base_not_in_pr

# --- Diff mode: Removal and addition (complex diff) ---
git checkout main > /dev/null 2>&1
git checkout main
cat <<'EOF' > CHANGELOG.md
# Changelog

Expand All @@ -296,9 +296,9 @@ cat <<'EOF' > CHANGELOG.md
EOF

git add CHANGELOG.md
git commit -m "Update main with removable feature" > /dev/null 2>&1
git commit -m "Update main with removable feature"

git checkout -b feature-replace > /dev/null 2>&1
git checkout -b feature-replace

# Remove one line and add another with breaking change
cat <<'EOF' > CHANGELOG.md
Expand All @@ -317,7 +317,7 @@ cat <<'EOF' > CHANGELOG.md
EOF

git add CHANGELOG.md
git commit -m "Replace feature with breaking change" > /dev/null 2>&1
git commit -m "Replace feature with breaking change"

# Diff should show:
# -- Feature that will be removed
Expand All @@ -335,7 +335,7 @@ test_diff_with_removal_and_breaking_addition() {
expect_success "diff mode: removal and breaking addition" test_diff_with_removal_and_breaking_addition

# --- Diff mode: Breaking change is removed ---
git checkout main > /dev/null 2>&1
git checkout main
cat <<'EOF' > CHANGELOG.md
# Changelog

Expand All @@ -354,9 +354,9 @@ cat <<'EOF' > CHANGELOG.md
EOF

git add CHANGELOG.md
git commit -m "Add breaking change to main that will be removed" > /dev/null 2>&1
git commit -m "Add breaking change to main that will be removed"

git checkout -b feature-remove-breaking > /dev/null 2>&1
git checkout -b feature-remove-breaking

# Remove the breaking change entry
cat <<'EOF' > CHANGELOG.md
Expand All @@ -375,7 +375,7 @@ cat <<'EOF' > CHANGELOG.md
EOF

git add CHANGELOG.md
git commit -m "Remove breaking change and add non-breaking feature" > /dev/null 2>&1
git commit -m "Remove breaking change and add non-breaking feature"

# Diff should show:
# +- Non-breaking feature added
Expand All @@ -395,7 +395,7 @@ test_diff_breaking_removed() {
expect_success "diff mode: breaking change removed in PR" test_diff_breaking_removed

# --- Diff mode: Removed section added in PR ---
git checkout main > /dev/null 2>&1
git checkout main
cat <<'EOF' > CHANGELOG.md
# Changelog

Expand All @@ -411,9 +411,9 @@ cat <<'EOF' > CHANGELOG.md
EOF

git add CHANGELOG.md
git commit -m "Main without Removed section" > /dev/null 2>&1
git commit -m "Main without Removed section"

git checkout -b feature-add-removed > /dev/null 2>&1
git checkout -b feature-add-removed

cat <<'EOF' > CHANGELOG.md
# Changelog
Expand All @@ -433,7 +433,7 @@ cat <<'EOF' > CHANGELOG.md
EOF

git add CHANGELOG.md
git commit -m "Add Removed section" > /dev/null 2>&1
git commit -m "Add Removed section"

# Diff should show the new Removed section
reset_output
Expand All @@ -446,5 +446,27 @@ test_diff_removed_section() {
}
expect_success "diff mode: Removed section added in PR" test_diff_removed_section

# --- Diff mode: No CHANGELOG changes at all ---
# Main is already in the state we need from previous test
git checkout main
git checkout -b feature-no-changelog-changes

# Make changes to other files but NOT CHANGELOG
echo "some code" > code.txt
git add code.txt
git commit -m "Change code but not changelog"

# Diff should be empty for CHANGELOG.md
# Script should not fail and should report no breaking changes
reset_output
test_diff_no_changelog_changes() {
env CHECK_MODE=diff \
BASE_REF=main \
CHANGELOG_PATH=CHANGELOG.md \
"$SCRIPT_DIR/check_breaking_changes.sh"
check_has_breaking "false"
}
expect_success "diff mode: no CHANGELOG changes at all" test_diff_no_changelog_changes

echo ""
echo "All tests passed!"