Open Weissger opened 5 months ago
Thanks for the thorough description! Could you add the feature to the readme, and also add a test?
All modified and coverable lines are covered by tests :white_check_mark:
Comparison is base (
7ebdacd
) 94.11% compared to head (a4f9573
) 94.11%.
:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Thanks for the thorough description! Could you add the feature to the readme, and also add a test?
Sure. Can do in the coming days / weeks.
Alternatively (or additionally) to this change I would prefer if commit-and-tag-version
would allow for defining differing ParseOpts
/WriterOpts
for the bump
and changelog
lifecycle as users might want to handle them slightly differently. This would already resolve my current issue without the need for an overwrite of the whatBump
function.
Otherwise v11.2.3 removed a hidden feature I was relying on 😄
It also looks like conventional-changelog-conventionalcommits
unfortunately has another hardcoded part in the writer transforming the tiles of all existing footers into 'BREAKING CHANGES'.
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.