Skip to content
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.

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

Using --changelog regenerates the full changelog instead of just the current increment #1024

Closed
edgarrmondragon opened this issue Mar 13, 2024 · 6 comments · Fixed by #1026
Closed

Comments

@edgarrmondragon
Copy link
Contributor

Description

Starting with v3.18.1, using --changelog generates the full catalog instead of only prepending the changes for the current increment.

This can be seen even in the GitHub release notes of commitizen itself starting with v3.18.2: they now include the full changelog.

Steps to reproduce

For example:

cz --no-raise 21 bump --yes --changelog --files-only --check-consistency --changelog-to-stdout >_changelog_fragment.md

Current behavior

The full changelog is regenerated instead of just the current increment.

Desired behavior

Only generate the current increment section of the changelog.

Screenshots

Screenshot 2024-03-13 at 2 06 46 p m

Environment

  • commitizen version: 3.18.3
  • python version: Python 3.12.2
  • operating system: Darwin
@woile
Copy link
Member

woile commented Mar 13, 2024

Good point, thanks for raising the issue, we'll take a look tomorrow. @noirbizarre any thoughts what could've been the issue? Thanks

@woile
Copy link
Member

woile commented Mar 14, 2024

A FIX is on its way, awaiting for @noirbizarre

@noirbizarre
Copy link
Member

Yes, sorry I noticed that.
I think I will revert the change (tomorrow) and provide a more robust approach.
In fact we have a design flaw to fix: the way we are handling --changelog-to-stdout on the bump command we can't have both dry-run, incremental and changelog_hook at the same time

@woile
Copy link
Member

woile commented Mar 14, 2024

I made a PR: #1026 I think to patch this issue it works, but fill free to send more commits to that PR

@woile
Copy link
Member

woile commented Mar 14, 2024

Please confirm if it's working now, 🙏🏻

@edgarrmondragon
Copy link
Contributor Author

edgarrmondragon commented Mar 14, 2024

Please confirm if it's working now, 🙏🏻

@woile I can confirm only the increment is generated when using 3.18.4 🎉. Thanks for the quick turnaround!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants