Skip to content

fix(release): collapse double blank line after Unreleased heading #114

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

Merged
zfarrell merged 1 commit into from
Jun 16, 2026
Merged

fix(release): collapse double blank line after Unreleased heading #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions scripts/update_changelog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ def update_changelog_text(text: str, ver: str, date: str) -> str:
f"- Release {ver}\n\n"
)
return re.sub(
r"^(## \[Unreleased\]\s*\n)(.*?)(?=^## \[|\Z)",
lambda match: match.group(1) + "\n" + section,
r"^## \[Unreleased\]\s*\n.*?(?=^## \[|\Z)",
lambda _match: f"## [Unreleased]\n\n{section}",
text,
count=1,
flags=re.M | re.S,
Expand Down
4 changes: 4 additions & 0 deletions tests/test_update_changelog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ def test_empty_unreleased_inserts_version_without_duplicate_heading():
assert "## [0.1.2] - 2026-05-20" in result
assert "The format is based on [Keep a Changelog]" in result.split("## [0.1.2]")[0]
assert result.index("## [0.1.2]") < result.index("## [0.1.1]")
assert "## [Unreleased]\n\n## [0.1.2]" in result
assert "\n\n\n" not in result


def test_populated_unreleased_moves_notes_into_new_section():
Expand All @@ -46,3 +48,5 @@ def test_populated_unreleased_moves_notes_into_new_section():
assert "- New widget." in result
assert result.index("- New widget.") < result.index("## [0.1.1]")
assert "The format is based on [Keep a Changelog]" in result.split("## [0.1.2]")[0]
assert "## [Unreleased]\n\n## [0.1.2]" in result
assert "\n\n\n" not in result