Skip to content

cz changelog --no-prereleases #364

Closed

Description

@yajo

Description

Sometimes I don't want prereleases to be displayed in the changelog. For me, commits in a prerelease should land in the Unreleased section. Then, once the final release is out, changes from all involved prereleases should appear in the final release.

Possible Solution

Add --no-prereleases to cz changelog, so prerelease tags are simply ignored.

Another solution would be that, when a final release is published, all its prereleases notes land in the final one, and the prereleases sections, either disappear or get hidden with a <details> element.

Activity

  1. nbrugger-tgm commented on Nov 21, 2021

    @nbrugger-tgm

    This sounds very applealing. Especially if #415 is implemented as it would lead to an empty release.

    Scenario

    1.2.3
    commit feat: 1
    bump -pr beta -> 1.3.0b
    commit fix: 2
    bump -pr rc -> 1.3.0rc
    bump (prod) -> 1.3.0     (This would be allowed after #415)
    

    Current changelog impl.

    # 1.3.0
    # 1.3.0rc
    ### Fix
    * 2
    # 1.3.0b
    ### Features
    * 1
    

    So the release itself is completely empty

  2. woile commented on Apr 28, 2023

    @woile
    Member

    this is possible doing:

    cz bump --changelog
    cz changelog --merge-prerelease
    

    If there's enough interest, we could propagate the setting through bump. Like

    cz bump --changelog --merge-prerelease
    

    Which is not possible at the moment. Please open a new issue or a PR

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions