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

Allow special handling for "skipped" breaking changes #106

Closed
alerque opened this issue Aug 24, 2022 · 0 comments · Fixed by #114
Closed

Allow special handling for "skipped" breaking changes #106

alerque opened this issue Aug 24, 2022 · 0 comments · Fixed by #114
Assignees
Labels
feature/request New feature or request

Comments

@alerque
Copy link
Contributor

alerque commented Aug 24, 2022

On many of my projects, I choose to skip some scopes in the changelog, for example chore and refactor. This keeps the noise down and allows people to see features and fixes without the distraction of all the moving cheese.

However sometimes one of those commits will be marked as a breaking change (chore!: ....). These commits should not be skipped in the changelog. I found I catch these with a commit parser added early in the list. Unfortunately the other rules setting group titles then don't get applied.

commit_parsers = [
    { message = ".*!:", skip = false },
    { message = "^chore", group = "Miscellaneous Tasks", skip = true },
]

I can work it out by having duplicate rules for each group with breaking changes not being skipped and others being skipped, but it means a lot more rules that I would have expected.

I think there should probably be some top level support for handling breaking changes such that they can always override skip values.

@alerque alerque added the feature/request New feature or request label Aug 24, 2022
sbmueller added a commit to sbmueller/git-cliff that referenced this issue Oct 1, 2022
sbmueller added a commit to sbmueller/git-cliff that referenced this issue Oct 1, 2022
sbmueller added a commit to sbmueller/git-cliff that referenced this issue Oct 1, 2022
sbmueller added a commit to sbmueller/git-cliff that referenced this issue Oct 3, 2022
sbmueller added a commit to sbmueller/git-cliff that referenced this issue Oct 3, 2022
sbmueller added a commit to sbmueller/git-cliff that referenced this issue Oct 4, 2022
@orhun orhun closed this as completed in #114 Oct 4, 2022
orhun added a commit that referenced this issue Oct 4, 2022
* feat(changelog): breaking changes are never skipped

Fixes #106

* test(fixture): add test fixture for skipping breaking changes

Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature/request New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants