-
Notifications
You must be signed in to change notification settings - Fork 40
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 overwriting whatBump of presets #128
base: master
Are you sure you want to change the base?
Allow overwriting whatBump of presets #128
Conversation
Thanks for the thorough description! Could you add the feature to the readme, and also add a test? |
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #128 +/- ##
=======================================
Coverage 94.11% 94.11%
=======================================
Files 26 26
Lines 493 493
=======================================
Hits 464 464
Misses 29 29 ☔ View full report in Codecov by Sentry. |
Sure. Can do in the coming days / weeks. Alternatively (or additionally) to this change I would prefer if Otherwise v11.2.3 removed a hidden feature I was relying on 😄 |
It also looks like |
Apologies for breaking behaviour without realising! tbh, I’m not wild about the way this package exposes the internals of the conventional changelog packages- it makes it hard to reason about breaking changes. I think it would be a pretty substantial change to decouple this, though Since that’s probably a substantial refactor, I think allowing separate parseOpts / writerOpts is a reasonable concession- I’d happily accept a PR that does that if you have the time to raise one. |
Heya! Did you get a chance to add this to the documentation / tests? |
Hey! Unfortunately life happened and I didn't find time until now. I'll try to follow up as soon as possible. |
The implementation of
conventional-recommended-bump
allows to pass awhatBump
function which isn't the result of preset loading.I added a simple passthrough from args to the
conventionalRecommendedBump
call to allow easily overwriting the preset definedwhatBump
.Why was this added
Since the release of following changes in v11.2.3 I got an issue with my use-case for using the library.
I'm using custom notes / footers in my commit messages using the tool. This should follow the conventional commit spec
Unfortunately the basic whatBump function interprets every single commit containing a footer as BREAKING CHANGE.
Generally the logic of
conventional-changelog-conventionalcommits
should be updated, but allowing for overwriting the function of a preset gives a nice flexibility for all presets and customized applications of the library.