fix(1694): changelog_merge_prerelease not working on cz bump#1700

zimmermannJakob · 2025-12-07T14:58:04Z

Description

This PR solves issue #1694.

Checklist

I have read the contributing guidelines

Code Changes

Add test cases to all the changes you introduce
Run poetry all locally to ensure this change passes linter check and tests (Some error out on mac. I will investigate if they fail in ci)
Manually test the changes:
- Verify the feature/bug fix works as expected in real-world scenarios
- Test edge cases and error conditions (I thought about breaking changes and starting an empty changelog with prereleases.)
- Ensure backward compatibility is maintained
- Document any manual testing steps performed
  ~~- [ ] Update the documentation for the changes~~ (I do not think this applies. It works now as documented.)

~~### Documentation Changes~~

~~- [ ] Run poetry doc locally to ensure the documentation pages renders correctly~~
~~- [ ] Check and fix any broken links (internal or external) in the documentation~~

When running poetry doc, any broken internal documentation links will be reported in the console output like this:
INFO - Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'. 

Expected Behavior

See issue #1694.

Steps to Test This Pull Request

build the changes on the branch. poetry build.
Take the resulting .wheel file from dist/
Install the file in a separate python environment:

python3 -m venv .venv && source .venv/bin/activate
verify env: which pip
pip install commitizen-4.10.0-py3-none-any.whl

Go through the steps in the issue description and try reproducing the bug.

Additional Context

~~Known issue: When the changelog only contains pre-releases, the old behavior can still be observed.~~ (Fixed)

…lease during bump

…_prerelease

…ntains only prereleases

codecov · 2025-12-09T17:28:51Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.91%. Comparing base (120d514) to head (646cc6c).
⚠️ Report is 886 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #1700 +/- ## ========================================== + Coverage 97.33% 97.91% +0.57%  ========================================== Files 42 60 +18 Lines 2104 2641 +537 ========================================== + Hits 2048 2586 +538 + Misses 56 55 -1

Flag	Coverage Δ
unittests	`97.91% <100.00%> (+0.57%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…th not present

…rking-on-cz-bump

woile

Very nice, thanks!

bearomorphism · 2025-12-14T13:25:45Z

tests/commands/test_bump_command.py

+cli.main()
+
+testargs= ["cz", "bump", "--changelog"]
+


nit: remove this blank line

bearomorphism · 2025-12-14T13:29:16Z

commitizen/changelog.py

+ifduring_version_bumpandrules.merge_prereleases:
+current_tag=None
+else:
+current_tag=get_commit_tag(commits[0], tags) ifcommitselseNone


Suggested change
ifduring_version_bumpandrules.merge_prereleases:
current_tag=None
else:
current_tag=get_commit_tag(commits[0], tags) ifcommitselseNone
ifduring_version_bumpandrules.merge_prereleasesandnotcommits:
current_tag=None
else:
# Check if the latest commit is not tagged
current_tag=get_commit_tag(commits[0], tags)

I think it would be or not commits, in which case I find it more readable as is.

Yes, thanks

bearomorphism · 2025-12-14T13:32:35Z

commitizen/commands/bump.py

 "incremental": True,
 "dry_run": dry_run,
+"during_version_bump": self.arguments["prerelease"]
+isNone, # We let the changelog implementation know that we want to replace prereleases while staying incremental AND the new tag does not exist already


The comment is a bit unclear to me.

Fair. Was more of a note to self. I changed it to something more meaningful.

bearomorphism · 2025-12-14T13:40:03Z

commitizen/changelog_formats/base.py

+latest_version_index=index
+line=line.strip().lower()
+
+parsed=self.parse_version_from_title(line)


Could you rename the variable parsed to something more clear? Such as parsed_version. As well as the parsed in another function get_metadata_from_file.
Thanks!

bearomorphism · 2025-12-14T13:41:16Z

commitizen/changelog_formats/base.py

+ifparsed:
+ifnotself.tag_rules.extract_version(
+GitTag(parsed.tag, "", "")
+ ).is_prerelease:


Combine these if statements with and

bearomorphism · 2025-12-14T13:44:45Z

commitizen/changelog_formats/base.py

+ ) aschangelog_file:
+returnself.get_latest_full_release_from_file(changelog_file)
+
+defget_latest_full_release_from_file(self, file: IO[Any]) ->IncrementalMergeInfo:


Why extract this function? I don't see any benefits.
You could put the whole function body under with open block and the logic is still clear.

I followed the same pattern as with metadata, which also has an interface calling the get function, which in turn calls the get_from_file function. I think both works, but I would prefer to leave it as is to stay consistent.

zimmermannJakob · 2025-12-15T20:00:00Z

@woile @bearomorphism Thank you for your reviews!
@bearomorphism I applied your suggestions, but left the conversations open for you to verify. Where I disagreed with a suggestion, I stated why.

bearomorphism · 2025-12-16T04:44:39Z

The latest commit should not be chore. I'd suggest you to rebase the commits and adjust the commit messages, so the commit history will be cleaner after merging

bearomorphism · 2025-12-16T04:52:40Z

I believe there is a way to mock the datetime in your new tests

bearomorphism · 2025-12-16T04:57:05Z

I remember git commit timestamp can be specified

Thanks!🙏

zimmermannJakob added 2 commits December 7, 2025 14:56

fix(changelog_merge_prerelease): changelog not merged during cz bump
9c98974

test(changelog_merge_prerelease): add tests for changelog_merge_prere…
8516635
…lease during bump

github-actionsbot added pr-status: wait-for-review type: bug labels Dec 7, 2025

zimmermannJakob added 2 commits December 9, 2025 18:20

test(test_bump_command.py): cleanup and fix tests for changelog_merge…
938f66a
…_prerelease

fix(changelog): fix merge_prerelease flag not working if changelog co…
73aa8a3
…ntains only prereleases

zimmermannJakob added 2 commits December 13, 2025 14:09

test(test_changelog_format): test get_latest_full_release with filepa…
12e8d0b
…th not present

Merge branch 'master' into 1694-fix-changelog_merge_prerelease-not-wo…
747ed1f
…rking-on-cz-bump

zimmermannJakob marked this pull request as ready for review December 13, 2025 14:29

zimmermannJakob requested review from Lee-W, noirbizarre and woile as code owners December 13, 2025 14:29

woile approved these changes Dec 14, 2025
View reviewed changes

bearomorphism reviewed Dec 14, 2025
View reviewed changes

chore: apply PR review suggestions
646cc6c

Uh oh!

fix(1694): changelog_merge_prerelease not working on cz bump#1700

Are you sure you want to change the base?

fix(1694): changelog_merge_prerelease not working on cz bump #1700

Uh oh!

Conversation

zimmermannJakob commented Dec 7, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Code Changes

Expected Behavior

Steps to Test This Pull Request

Additional Context

Uh oh!

codecovbot commented Dec 9, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

woile left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zimmermannJakob commented Dec 15, 2025

Uh oh!

bearomorphism commented Dec 16, 2025

Uh oh!

bearomorphism commented Dec 16, 2025

Uh oh!

bearomorphism commented Dec 16, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zimmermannJakob commented Dec 7, 2025•
edited
Loading

codecovbot commented Dec 9, 2025•
edited
Loading

bearomorphism commented Dec 16, 2025•
edited
Loading