feature: changelog_message_build_hook
can remove message by returning a falsy value
#1001
+53
−14
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.
Description
This PR allows
changelog_message_build_hook
to remove commits from the changelog just by returningNone
or any falsy value.Testing this PR made me realize than the hook was ignored for body messages and fix this case.
Note: some changes are just formatting from the
scripts/format
execution.Checklist
./scripts/format
and./scripts/test
locally to ensure this change passes linter check and testExpected behavior
The feature: if the
changelog_message_build_hook
return a falsy value (None
or{}
from expected types), the commit will be skipped into the changelog.Side-effect fix: the hook is also executed on the parsed body message given it is generated using the same
commit_parser
Steps to Test This Pull Request
changelog_message_build_hook
Additional context
Next step will be to allow the opposite: allows this same hook to create multiple changelog entries from a single commit (by allowing returning a list or tuple I think)