Repository navigation
Parse breaking change footer - #158
Merged
Merged
Conversation
mate-amargo
force-pushed
the
parse_breaking_change
branch
from
October 25, 2026 14:50
17d7206 to
37d10c1
Compare
thekaveman
approved these changes
Oct 29, 2026
thekaveman
left a comment
thekaveman
left a comment
Member
There was a problem hiding this comment.
I chose to enforce it anyways regardless of
!.
I agree with this!
Thanks for your work on this @mate-amargo
Member
|
Thanks again @mate-amargo, this is now released on PyPI as |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR resolves #106
It adds a check for the body to look for
BREAKING CHANGE:and its proper formatting.I've followed the specifications from https://www.conventionalcommits.org/en/v1.0.0/
Notice that the convention states that if
!is specified in the delimiter, then theBREAKING CHANGEmight be omitted. So you could argue that a bad formattedBREAKING CHANGEcould be acceptable since it would be ignored when using!.I chose to enforce it anyways regardless of
!. That is, if there's a footer that says "breaking change:" and it's not all caps, the commit is rejected. (As per the convention, it can beBREAKING CHANGE:orBREAKING-CHANGE:with the dash.)I also added unit tests for the new cases.