Skip to content

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

@edgarrmondragon

Description

@edgarrmondragon
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

Activity

woile

woile commented on Mar 13, 2024

@woile
Member

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

added a commit that references this issue on Mar 14, 2024
94527d7
added 3 commits that reference this issue on Mar 14, 2024
11747e2
d5dd019
47762b6
woile

woile commented on Mar 14, 2024

@woile
Member

A FIX is on its way, awaiting for @noirbizarre

noirbizarre

noirbizarre commented on Mar 14, 2024

@noirbizarre
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

woile commented on Mar 14, 2024

@woile
Member

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

added a commit that references this issue on Mar 14, 2024
3c9988a
woile

woile commented on Mar 14, 2024

@woile
Member

Please confirm if it's working now, 🙏🏻

edgarrmondragon

edgarrmondragon commented on Mar 14, 2024

@edgarrmondragon
ContributorAuthor

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Participants

      @noirbizarre@woile@edgarrmondragon

      Issue actions

        Using `--changelog` regenerates the full changelog instead of just the current increment · Issue #1024 · commitizen-tools/commitizen