Skip to content

Commit d4f128e

Browse files
committed
feat(parser-scipy)!: set parser to ignore merge commits by default
BREAKING CHANGE: The configuration setting `commit_parser_options.ignore_merge_commits` is now set to `true` by default. The feature to ignore squash commits was introduced in `v9.18.0` and was originally set to `false` to prevent unexpected results on a non-breaking update. The ignore merge commits feature prevents additional unnecessary processing on a commit message that likely will not match a commit message syntax. Most merge commits are syntactically pre-defined by Git or Remote Version Control System (ex. GitHub, etc.) and do not follow a commit convention (nor should they). The larger issue with merge commits is that they ultimately are a full copy of all the changes that were previously created and committed. The merge commit itself ensures that the previous commit tree is maintained in history, therefore the commit message always exists. If merge commits are parsed, it generally creates duplicate messages that will end up in your changelog, which is less than desired in most cases. If you have previously used the `changelog.exclude_commit_patterns` functionality to ignore merge commit messages then you will want this setting set to `true` to improve parsing speed. You can also now remove the merge commit exclude pattern from the list as well to improve parsing speed. If this functionality is not desired, you will need to update your configuration to change the new setting to `false`.
1 parent 59bf084 commit d4f128e

File tree

1 file changed

+1
-2
lines changed
  • src/semantic_release/commit_parser

1 file changed

+1
-2
lines changed

src/semantic_release/commit_parser/scipy.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,7 @@ class ScipyParserOptions(ParserOptions):
150150
parse_squash_commits: bool = True
151151
"""Toggle flag for whether or not to parse squash commits"""
152152

153-
# TODO: breaking change v10, change default to True
154-
ignore_merge_commits: bool = False
153+
ignore_merge_commits: bool = True
155154
"""Toggle flag for whether or not to ignore merge commits"""
156155

157156
@property

0 commit comments

Comments
 (0)