semantic_release.commit_parser.conventional.options module¶
- class semantic_release.commit_parser.conventional.options.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 = True, ignore_merge_commits: bool = True)[source]¶
Bases:
ParserOptionsOptions dataclass for the ConventionalCommitParser.
- allowed_tags: Tuple[str, ...] = ('feat', 'fix', 'perf', 'build', 'chore', 'ci', 'docs', 'style', 'refactor', 'test')¶
All commit-type prefixes that are allowed.
These are used to identify a valid commit message. If a commit message does not start with one of these prefixes, it will not be considered a valid commit message.
- ignore_merge_commits: bool = True¶
Toggle flag for whether or not to ignore merge commits
- minor_tags: Tuple[str, ...] = ('feat',)¶
Commit-type prefixes that should result in a minor release bump.
- other_allowed_tags: Tuple[str, ...] = ('build', 'chore', 'ci', 'docs', 'style', 'refactor', 'test')¶
Commit-type prefixes that are allowed but do not result in a version bump.
- parse_squash_commits: bool = True¶
Toggle flag for whether or not to parse squash commits
- patch_tags: Tuple[str, ...] = ('fix', 'perf')¶
Commit-type prefixes that should result in a patch release bump.