ci: remove redundant incremental changelog setting - #2088
Merged
Merged
Conversation
The bump command already forces incremental changelog generation when update_changelog_on_bump is enabled. Setting changelog_incremental globally also affects the separate release-note command, where the positional version is a rev_range and conflicts with incremental mode. Keep update_changelog_on_bump enabled so automated bumps continue preserving changelog history, while allowing the existing exact-version dry-run to generate GitHub release notes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
🔍 Commitizen bump previewNo commits in this PR are eligible for a version bump. |
7 tasks
Lee-W
approved these changes
Sep 14, 2026
Member
|
Thanks!! |
Collaborator
Author
|
np, I introduced the regression actually :( |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Remove the repository-wide
changelog_incremental = truesetting that caused the v4.18.1 release workflow to fail with:This supersedes #2086 with a smaller, repository-specific fix.
Root cause
#2074 enabled two settings to restore changelog updates during automated bumps:
Only
update_changelog_on_bumpis needed. When that setting enables changelog generation,commitizen.commands.bump.Bumpalready invokesChangelogwithincremental=True. Existing coverage intest_bump_changelog_contains_increment_onlyverifies that configuration updates only the new changelog section.The additional global
changelog_incremental = truealso affected the later, independent release-note command:cz changelog --dry-run "${NEW_VERSION}"${NEW_VERSION}is the command's positionalrev_range. Commitizen intentionally rejects combining a revision range with incremental generation, so the redundant global setting made this command fail.--dry-runitself is unrelated to the conflict, and the equivalent setup-cz example remains valid for projects that do not globally enable incremental changelogs.Fix
Keep
update_changelog_on_bump = true, preserving incremental changelog updates duringcz bump, and remove onlychangelog_incremental = true. The existing workflow command can then generate notes for the exact release revision without changing Commitizen's public CLI.Validation
uv run cz changelog --dry-run 4.18.1generates the expected v4.18.1 section.uv run pytest -q tests/commands/test_bump_command.py -k bump_changelog_contains_increment_onlypasses, confirming automated bump changelogs remain incremental.Release recovery
The failed job had already pushed the
v4.18.1bump commit and tag beforegh release createran. This prevents the same conflict in future runs, but the missing v4.18.1 GitHub Release must be created separately from the existing tag.Checklist
Was generative AI tooling used to co-author this PR?
Generated-by: GitHub Copilot following the guidelines