semantic_release.commit_parser.conventional module¶
- class semantic_release.commit_parser.conventional.ConventionalCommitParser(options: ConventionalCommitParserOptions | None = None)[source]¶
Bases:
AngularCommitParser
A commit parser for projects conforming to the conventional commits specification.
See https://www.conventionalcommits.org/en/v1.0.0/
- static get_default_options() ConventionalCommitParserOptions [source]¶
- parser_options¶
alias of
ConventionalCommitParserOptions
- class semantic_release.commit_parser.conventional.ConventionalCommitParserOptions(minor_tags: Tuple[str, ...] = ('feat',), patch_tags: Tuple[str, ...] = ('fix', 'perf'), other_allowed_tags: Tuple[str, ...] = ('build', 'chore', 'ci', 'docs', 'style', 'refactor', 'test'), allowed_tags: Tuple[str, ...] = ('feat', 'fix', 'perf', 'build', 'chore', 'ci', 'docs', 'style', 'refactor', 'test'), default_bump_level: LevelBump = LevelBump.NO_RELEASE, parse_squash_commits: bool = False, ignore_merge_commits: bool = False)[source]¶
Bases:
AngularParserOptions
Options dataclass for the ConventionalCommitParser.