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
Enable footer-based commit parsing. The idea is to add functionality like
I would appreciate some guidance – is this useful, desired, worth it, …?
Motivation and Context
In order to keep my changelogs concise, I would like to ignore certain commits. I would like to specify whether a commit should be ignored in the commit message. A somewhat elegant way to achieve this (I think) would be to include a footer like
changelog: ignore
.(If you have a better way to approach this, I'm happy to learn of it.)
How Has This Been Tested?
Append existing tests that create sample changelogs.
The test
changelog_generator_split_commits
is failing. It appears that a footer's value (but not the key) makes its way into the changelog. This might be because the footer's key is interpreted as a conventional commit type. I would appreciate some guidance here.Possible Limitations
The conventional commits' specification and the reference implementation of its parser are currently out of sync. This might mean that the commit parser
{footer = "Hello: world"}
does not work (even though it should), whereas the commit parser{footer = "Hello:world"}
does work (even though omitting the space goes against the specification).Some relevant issues concerning footer parsing are:
:
token in footers conventional-commits/parser#47:
requires space crate-ci/git-conventional#54Types of Changes
Checklist: