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

Breaking change not added to CHANGELOG.md #148

Open
philippeboyd opened this issue May 12, 2021 · 1 comment
Open

Breaking change not added to CHANGELOG.md #148

philippeboyd opened this issue May 12, 2021 · 1 comment
Labels
type: bug Something isn't working

Comments

@philippeboyd
Copy link

philippeboyd commented May 12, 2021

Expected Behavior

BREAKING CHANGE section added to CHANGELOG

Actual Behavior

BREAKING CHANGE section not added to CHANGELOG

Steps to Reproduce (including precondition)

git clone https://github.com/git-chglog/git-chglog.git
# git commit --amend
# add a footer note: 
# BREAKING CHANGE: big breaking change!
git-chglog -o CHANGELOG.md
git diff

# you'll then see that no breaking change section is added.

Your Environment

  • OS: OSX Big Sur
  • git-chglog version: 0.14.2
@mavogel mavogel added the type: bug Something isn't working label May 14, 2021
@clok
Copy link
Collaborator

clok commented May 20, 2021

Thank you for the report @philippeboyd

It looks like what is happening is that when the change set is a part of the Unreleased category, the BREAKING CHANGE is not caught. You can test his by running the same repro case with the --next-tag <ANYTHING> set. This will inject a pseudo tag and result in the BREAKING CHANGE to be noted as expected.

I have been wanting to find time to refactor how the Unreleased and next-tag features are handled within the tool. There are some tricky cases to handle, but it would be nice if the behavior was consistent across all "tags" regardless if they are real, pseudo or unreleased.

See #145 and #76 for those issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants