-
-
Notifications
You must be signed in to change notification settings - Fork 204
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
feat(changelog): do not skip breaking changes if configured #114
Conversation
Codecov ReportBase: 64.06% // Head: 64.46% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #114 +/- ##
==========================================
+ Coverage 64.06% 64.46% +0.41%
==========================================
Files 14 14
Lines 790 799 +9
==========================================
+ Hits 506 515 +9
Misses 284 284
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
91726b8
to
f4b6e95
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Just a few edits needed, see my comments 🐻
I added test fixtures for this PR in 4e61f30 |
4e61f30
to
12e298b
Compare
Thanks @orhun for the review! I think I addressed everything now. Feel free to add more comments if unsure about something. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great stuff, thanks for your contribution! 🐻
Hi there! Trying to contribute to this project first-time.
Description
Trying to resolve #106 by option to protect breaking changes, even when matched by a skipping commit parser. The option
protect_breaking_commits
is introduced in the config.Note that during testing, one caveat was discovered: If a commit is matched by one parser, it can't be matched by any other. That means if a breaking commit was prevented from being skipped, it won't become part of any other group. Maybe it is worth to think about allowing multiple parsers for commits in an hierarchical order?
Motivation and Context
Breaking changes are highly relevant for stakeholders, therefore should not be skipped in a changelog, even when matched by commit parsers.
Fixes #106
How Has This Been Tested?
Extended the test cases by breaking change commits. Added a usual breaking change commit and one that matches a skipped commit parser regex. The latter is not skipped even it matches a commit parser that has
skip
set to true, ifprotect_breaking_commits
is true.nightly-aarch64-apple-darwin / rustc 1.66.0-nightly (8ce3204af 2022-09-30)
Backward compatibility is provided.
Screenshots / Output (if appropriate):
See tests in
src/changelog.rs
Types of changes
Checklist: