Add option to control patch subject cleaning #36
Merged
Conversation
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
When processing mail-formatted patches, the default cleanup removed all leading content in square brackets, but this pattern is often used to identify tickets or other information that should remain in the commit title. Git supports disabling this the the `-k` and `-b` flags, which we simulate with the new SubjectCleanMode options. Use WithSubjectCleanMode(SubjectCleanPatchOnly) to only remove bracketed strings that contain "PATCH", keeping others that are (probably) part of the actual commit message. Note that because of the mail parsing library, we cannot replicate the `-k` flag exactly and always clean leading and trailing whitespace.
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.
When processing mail-formatted patches, the default cleanup removed all leading content in square brackets, but this pattern is often used to identify tickets or other information that should remain in the commit title. Git supports disabling this the the
-kand-bflags, which we simulate with the newSubjectCleanModeoptions.Use
WithSubjectCleanMode(SubjectCleanPatchOnly)to only remove bracketed strings that contain "PATCH", keeping others that are (probably) part of the actual commit message.Note that because of the mail parsing library, we cannot replicate the
-kflag exactly and always clean leading and trailing whitespace.Fixes #33.