feat: new option transformCommits
to postprocess commits
#185
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a new option
transformCommits
to postprocess commit list before release notes are generated.While it is possible to create a custom reader it might not always be desirable to maintain a forked to only augment slightly. Additionally the reader is only passed the commit message and not the full parsed data such as SHA. My personal use-case is to automatically set the scope of the commit in a monorepo setup based on which packages the commit touches.
The option can either be a function (usable when using a
.js
configuration file) or anything resolvable usingrequire
which default exports a single function. In both cases the function takes a single commit object (same object as is passed toconventional-changelog-writer
later) and expects it to return a similar transformed object.