René's URL Explorer Experiment

Title: feat(bump): add --merge-prerelease flag by bearomorphism · Pull Request #1968 · commitizen-tools/commitizen · GitHub

Open Graph Title: feat(bump): add --merge-prerelease flag by bearomorphism · Pull Request #1968 · commitizen-tools/commitizen

X Title: feat(bump): add --merge-prerelease flag by bearomorphism · Pull Request #1968 · commitizen-tools/commitizen

Description: Description Closes #1934. Why cz changelog already exposes a --merge-prerelease flag that overrides the changelog_merge_prerelease config setting for a single invocation. The same flag is missing on cz bump, even though cz bump --changelog runs the same changelog generator under the hood. Users who want prerelease entries to live as separate sections in their changelog by default, but be merged into the release entry on the actual release bump, currently have to either edit pyproject.toml for one bump and revert it, or run cz bump followed by a separate cz changelog --merge-prerelease. The original issue calls for parity: It would be great to enable/disable changelog_merge_prerelease when calling cz bump in combination with update_changelog_on_bump = true/--changelog. What changed File Change commitizen/cli.py New --merge-prerelease argument under the bump subcommand (mirrors the one under changelog). commitizen/commands/bump.py BumpArgs gains merge_prerelease: bool | None; Bump.__call__ forwards it into changelog_args only when explicitly set. docs/commands/bump.md New ### --merge-prerelease section. tests/commands/test_bump_command.py New parameterised test_changelog_cli_flag_merge_prerelease[rc|alpha|beta] that exercises the flag without setting the config. tests/commands/test_bump_command/test_changelog_cli_flag_merge_prerelease_*.md Three regression fixtures (one per prerelease variant). tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_*_bump_.txt Regenerated cz bump --help snapshots (one per supported Python). How it works The argparse argument uses action="store_true", default=None. The None default is intentional: it lets Bump.__call__ distinguish "user did not pass the flag" from "user passed --no-merge-prerelease-equivalent" without a separate negation flag. When the flag is absent the embedded Changelog invocation falls back to self.config.settings["changelog_merge_prerelease"] exactly as before — no behaviour change. In Bump.__call__, merge_prerelease is injected into changelog_args only when is not None. Because Changelog.__init__ evaluates arguments.get("merge_prerelease") or self.config.settings["changelog_merge_prerelease"], omitting the key from changelog_args correctly preserves the legacy behaviour. Both code paths in Bump.__call__ that construct a Changelog (the changelog_to_stdout path and the regular file path) receive the changelog_args dict, so the new flag is effective in both modes. The flag has no effect unless cz bump actually generates a changelog (--changelog, --changelog-to-stdout, or update_changelog_on_bump = true); a no-op flag without --changelog matches cz changelog's behaviour and avoids surprises. Backward compatibility All existing config combinations behave identically when the flag is absent. BumpArgs.merge_prerelease: bool | None is additive on a total=False TypedDict. The full pre-existing bump test suite (134 non-GPG tests) and cz bump --help snapshot tests pass unchanged after regeneration. 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 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 (poe lint clean; 134 non-GPG bump tests + 14 common-command help-text tests pass; the 4 GPG-signing test errors on Windows are pre-existing and unrelated to this change) Manually test the changes (see "Steps to Test" below for the exact commands) Update the documentation for the changes Documentation Changes Added a ### --merge-prerelease section to docs/commands/bump.md Help-text snapshots regenerated via uv run poe test:regen Run uv run poe doc locally to ensure the documentation pages render correctly Check and fix any broken links (internal or external) Expected Behavior Scenario Outcome cz bump --changelog (no flag, changelog_merge_prerelease = false — default) Prereleases keep their own sections in the changelog (legacy behaviour). cz bump --changelog --merge-prerelease Prereleases between previous and new non-prerelease are collapsed into the new entry. cz bump --changelog with changelog_merge_prerelease = true in config Prereleases are merged (legacy behaviour). cz bump --merge-prerelease (no --changelog, no update_changelog_on_bump) Flag is a no-op; no changelog is generated. cz bump --changelog-to-stdout --merge-prerelease Stdout changelog also has prereleases merged. Steps to Test This Pull Request git fetch fork feat/1934-bump-merge-prerelease-flag git checkout fork/feat/1934-bump-merge-prerelease-flag # 1. Targeted regression test (3 new + 6 pre-existing parametrised cases). uv run pytest tests/commands/test_bump_command.py -k merge_prerelease -v # expected: 9 passed # 2. Full bump-command suite (sanity check that nothing else broke). uv run pytest tests/commands/test_bump_command.py -k 'not signed' -q # expected: 134 passed (GPG-signing tests are excluded on Windows) # 3. Help snapshots updated correctly. uv run pytest tests/commands/test_common_command.py -q # expected: 14 passed # 4. End-to-end smoke (optional, requires a temp git repo): mkdir -p /tmp/cz-1968 && cd /tmp/cz-1968 && git init -q echo '[tool.commitizen]\nname = "cz_conventional_commits"\nversion = "0.1.0"\nupdate_changelog_on_bump = true\ntag_format = "v$version"' > pyproject.toml git add . && git -c user.email=a@b -c user.name=t commit -qm "feat: a" uv run cz bump --yes -pr alpha # -> v0.2.0a0 git -c user.email=a@b -c user.name=t commit --allow-empty -qm "fix: b" uv run cz bump --yes --changelog --merge-prerelease # collapses 0.2.0a0 entry cat CHANGELOG.md # 0.2.0 should contain both feat:a and fix:b under it Additional Context Surfaced while triaging open issues in #1965. Reviewed by an internal claude-sonnet-4.6 code-review pass and by GitHub Copilot; both reported no findings.

Open Graph Description: Description Closes #1934. Why cz changelog already exposes a --merge-prerelease flag that overrides the changelog_merge_prerelease config setting for a single invocation. The same flag is missing o...

X Description: Description Closes #1934. Why cz changelog already exposes a --merge-prerelease flag that overrides the changelog_merge_prerelease config setting for a single invocation. The same flag is missing o...

Opengraph URL: https://github.com/commitizen-tools/commitizen/pull/1968

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width