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

cz changelog --no-prereleases #364

Closed
yajo opened this issue Mar 31, 2021 · 2 comments
Closed

cz changelog --no-prereleases #364

yajo opened this issue Mar 31, 2021 · 2 comments
Labels
type: feature A new enhacement proposal

Comments

@yajo
Copy link
Contributor

yajo commented Mar 31, 2021

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.

@yajo yajo added the type: feature A new enhacement proposal label Mar 31, 2021
@nbrugger-tgm
Copy link

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

@woile
Copy link
Member

woile commented Apr 28, 2023

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

@woile woile closed this as completed Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature A new enhacement proposal
Projects
None yet
Development

No branches or pull requests

4 participants