fix(bump): preserve existing changelog header when `changelog_merge_prerelease` is used with `cz bump --changelog` by edgarrmondragon · Pull Request #1850 · commitizen-tools/commitizen

edgarrmondragon · 2026-02-05T02:09:19Z

Description

Fixes a regression introduced in v4.11.3 (370ac9d, #1700) where using cz bump --changelog with changelog_merge_prerelease = true results in the header of the existing changelog file being removed.

Checklist

I have read the contributing guidelines

Was generative AI tooling used to co-author this PR?

Yes (please specify the tool below)

Generated-by: Claude Code following the guidelines

Code Changes

Add test cases to all the changes you introduce
Run uv run poe all locally to ensure this change passes linter check and tests
Manually test the changes:
- Verify the feature/bug fix works as expected in real-world scenarios
- Test edge cases and error conditions
- Ensure backward compatibility is maintained
- Document any manual testing steps performed
Update the documentation for the changes

Documentation Changes

Run uv run poe doc locally to ensure the documentation pages renders correctly
Check and fix any broken links (internal or external)

Expected Behavior

Steps to Test This Pull Request

Additional Context

codecov · 2026-02-05T02:10:04Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.91%. Comparing base (2cfb8c6) to head (b9ed2c9).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1850      +/-   ##
==========================================
- Coverage   97.99%   97.91%   -0.08%     
==========================================
  Files          60       60              
  Lines        2691     2692       +1     
==========================================
- Hits         2637     2636       -1     
- Misses         54       56       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>

…rerelease` is used with `cz bump --changelog` Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>

…rerelease` is used with `cz bump --changelog`, and no prereleases exist Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>

## Description  ## Related Issues * commitizen-tools/commitizen#1850 Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>

bearomorphism

Thanks you for reporting this issue and providing a fix! A few nits

tests/commands/test_bump_command.py

commitizen/commands/changelog.py

Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>

edgarrmondragon · 2026-02-06T20:34:26Z

Thanks for the review @bearomorphism, this is ready for another pass.

tests/commands/test_bump_command.py

bearomorphism · 2026-02-07T01:18:45Z

Thanks!

Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>

edgarrmondragon · 2026-02-07T01:43:27Z

Thanks for the feedback again @bearomorphism!

In the latest commit I put all the relevant cases to my usecase in a single parametrized test:

The prerelease is merged into the final
The prerelease is preserved
There's no prerelase

In all cases I'm interested in the changelog header is preserved 😀

Copilot

Pull request overview

Fixes a regression in Commitizen’s bump + changelog generation where enabling changelog_merge_prerelease could remove the existing changelog header during cz bump --changelog.

Changes:

Update changelog generation logic to preserve existing header content when prerelease-merging is enabled.
Add regression test coverage for preserving the changelog header across prerelease/no-prerelease and merge/no-merge scenarios.
Add file-regression snapshots for the new header-preservation test cases.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
`commitizen/commands/changelog.py`	Adjusts prerelease-merge metadata handling so incremental writes don’t drop the preamble/header.
`tests/commands/test_bump_command.py`	Adds a new parametrized regression test ensuring headers are preserved under different prerelease/merge combinations.
`tests/commands/test_bump_command/test_changelog_merge_preserves_header_without_prerelease_.md`	Snapshot for header-preservation case with no prerelease involved.
`tests/commands/test_bump_command/test_changelog_merge_preserves_header_with_prerelease_no_merge_.md`	Snapshot for prerelease present but merging disabled.
`tests/commands/test_bump_command/test_changelog_merge_preserves_header_with_prerelease_merge_.md`	Snapshot for prerelease present and merging enabled.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-07T01:54:49Z

tests/commands/test_bump_command.py

 @pytest.mark.usefixtures("tmp_commitizen_project")
-def test_bump_deprecate_files_only(util: UtilFixture):
-    util.create_file_and_commit("feat: new file")
-    with (
-        pytest.warns(DeprecationWarning, match=r".*--files-only.*deprecated"),
-        pytest.raises(ExpectedExit),
-    ):
-        util.run_cli("bump", "--yes", "--files-only")
+@pytest.mark.freeze_time("2025-01-01")
+def test_changelog_merge_preserves_header(
+    mocker: MockFixture,
+    util: UtilFixture,
+    changelog_path: Path,


The existing deprecation test for --files-only (test_bump_deprecate_files_only) was removed in this hunk and doesn’t appear elsewhere in the test suite. This drops coverage for the expected DeprecationWarning + ExpectedExit behavior; please restore the test (or add an equivalent) alongside the new changelog header regression tests.

My fault I didn't see this section...

Ah, sorry about that!

I saw the drop in coverage for --files-only but didn't think more of that 🤦

github-actions bot added pr-status: wait-for-review type: bug labels Feb 5, 2026

edgarrmondragon added 3 commits February 4, 2026 20:11

test: Add a failing test

0c430ae

Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>

fix(bump): Preserve existing changelog header when `changelog_merge_p…

681a433

…rerelease` is used with `cz bump --changelog` Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>

fix(bump): Preserve existing changelog header when `changelog_merge_p…

778edcb

…rerelease` is used with `cz bump --changelog`, and no prereleases exist Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>

edgarrmondragon force-pushed the fix/bump-changelog-merge-pre-removes-header branch from 0c3bced to 778edcb Compare February 5, 2026 02:12

edgarrmondragon marked this pull request as ready for review February 5, 2026 02:17

edgarrmondragon requested review from Lee-W, noirbizarre and woile as code owners February 5, 2026 02:17

edgarrmondragon mentioned this pull request Feb 5, 2026

ci: Preserve prerelease notes in changelog meltano/meltano#9816

Merged

bearomorphism added the prority: high label Feb 5, 2026

bearomorphism approved these changes Feb 5, 2026

View reviewed changes

tests/commands/test_bump_command.py Outdated Show resolved Hide resolved

tests/commands/test_bump_command.py Outdated Show resolved Hide resolved

commitizen/commands/changelog.py Outdated Show resolved Hide resolved

bearomorphism added pr-status: wait-for-modification and removed pr-status: wait-for-review labels Feb 5, 2026

Merge branch 'master' into fix/bump-changelog-merge-pre-removes-header

fb214be

github-actions bot added the pr-status: wait-for-review label Feb 6, 2026

bearomorphism removed the pr-status: wait-for-review label Feb 6, 2026

github-actions bot added the pr-status: wait-for-review label Feb 6, 2026

test: Remove redundant assertions

397abe7

Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>

edgarrmondragon force-pushed the fix/bump-changelog-merge-pre-removes-header branch from 227e12e to 397abe7 Compare February 6, 2026 20:28

refactor: Inline condition and rely on comments to explain the logic

fbee607

Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>

edgarrmondragon commented Feb 6, 2026

View reviewed changes

tests/commands/test_bump_command.py Outdated Show resolved Hide resolved

test: Remove another redundant assertion

85b1f90

bearomorphism reviewed Feb 7, 2026

View reviewed changes

tests/commands/test_bump_command.py Outdated Show resolved Hide resolved

test: Use a single parametrized test

b9ed2c9

Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>

bearomorphism changed the title ~~fix(bump): Preserve existing changelog header when changelog_merge_prerelease is used with cz bump --changelog~~ fix(bump): preserve existing changelog header when changelog_merge_prerelease is used with cz bump --changelog Feb 7, 2026

bearomorphism enabled auto-merge (squash) February 7, 2026 01:43

bearomorphism approved these changes Feb 7, 2026

View reviewed changes

bearomorphism merged commit 4ed2653 into commitizen-tools:master Feb 7, 2026
20 checks passed

bearomorphism requested review from Copilot and removed request for Lee-W, noirbizarre and woile February 7, 2026 01:51

Copilot started reviewing on behalf of bearomorphism February 7, 2026 01:52 View session

edgarrmondragon deleted the fix/bump-changelog-merge-pre-removes-header branch February 7, 2026 01:54

Copilot AI reviewed Feb 7, 2026

View reviewed changes

bearomorphism mentioned this pull request Feb 7, 2026

test: add deprecated test back #1852

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(bump): preserve existing changelog header when `changelog_merge_prerelease` is used with `cz bump --changelog`#1850

fix(bump): preserve existing changelog header when `changelog_merge_prerelease` is used with `cz bump --changelog`#1850
bearomorphism merged 8 commits intocommitizen-tools:masterfrom
edgarrmondragon:fix/bump-changelog-merge-pre-removes-header

edgarrmondragon commented Feb 5, 2026 •

edited

Loading

Uh oh!

codecov bot commented Feb 5, 2026 •

edited

Loading

Uh oh!

bearomorphism left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

edgarrmondragon commented Feb 6, 2026

Uh oh!

Uh oh!

Uh oh!

bearomorphism commented Feb 7, 2026

Uh oh!

edgarrmondragon commented Feb 7, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

bearomorphism Feb 7, 2026

Uh oh!

edgarrmondragon Feb 7, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

edgarrmondragon commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Was generative AI tooling used to co-author this PR?

Code Changes

Documentation Changes

Expected Behavior

Steps to Test This Pull Request

Additional Context

Uh oh!

codecov bot commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

bearomorphism left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

edgarrmondragon commented Feb 6, 2026

Uh oh!

Uh oh!

Uh oh!

bearomorphism commented Feb 7, 2026

Uh oh!

edgarrmondragon commented Feb 7, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

bearomorphism Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

edgarrmondragon Feb 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

edgarrmondragon commented Feb 5, 2026 •

edited

Loading

codecov bot commented Feb 5, 2026 •

edited

Loading

edgarrmondragon Feb 7, 2026 •

edited

Loading