semantic_release.history.parser_scipy module¶
Parses commit messages using scipy tags of the form:
<tag>(<scope>): <subject>
<body>
The elements <tag>, <scope> and <body> are optional. If no tag is present, the commit will be added to the changelog section “None” and no version increment will be performed.
While <scope> is supported here it isn’t actually part of the scipy style. If it is missing, parentheses around it are too. The commit should then be of the form:
<tag>: <subject>
<body>
To communicate a breaking change add “BREAKING CHANGE” into the body at the beginning of a paragraph. Fill this paragraph with information how to migrate from the broken behavior to the new behavior. It will be added to the “Breaking” section of the changelog.
Supported Tags:
API, DEP, ENH, REV, BUG, MAINT, BENCH, BLD,
DEV, DOC, STY, TST, REL, FEAT, TEST
Supported Changelog Sections:
breaking, feature, fix, Other, None
- class semantic_release.history.parser_scipy.Breaking(tag, section)[source]¶
Bases:
ChangeType
- class semantic_release.history.parser_scipy.Compatible(tag, section)[source]¶
Bases:
ChangeType
- class semantic_release.history.parser_scipy.Ignore(tag, section)[source]¶
Bases:
ChangeType
- class semantic_release.history.parser_scipy.Patch(tag, section)[source]¶
Bases:
ChangeType
- semantic_release.history.parser_scipy.parse_commit_message(message: str) ParsedCommit [source]¶
Parse a scipy-style commit message
- Parameters:
message – A string of a commit message.
- Returns:
A tuple of (level to bump, type of change, scope of change, a tuple
with descriptions) :raises UnknownCommitMessageStyleError: if regular expression matching fails