Skip to content
Back to top
View this page

# semantic_release.commit_parser.conventional.options_monorepo module

class semantic_release.commit_parser.conventional.options_monorepo.ConventionalCommitMonorepoParserOptions(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, path_filters: Annotated[Tuple[str, ...], Field(validate_default=True)] = ('.',), scope_prefix: str = '')

  Bases: `ConventionalCommitParserOptions`

  Options dataclass for ConventionalCommitMonorepoParser.

  classmethod convert_strs_to_paths(value: Any) → tuple[str, ...]
  path_filters: Annotated[Tuple[str, ...], Field(validate_default=True)] = ('.',)

    A set of relative paths to filter commits by. Only commits with file changes that match these file paths or its subdirectories will be considered valid commits.

    Syntax is similar to .gitignore with file path globs and inverse file match globs via ! prefix. Paths should be relative to the current working directory.

  classmethod resolve_path(dir_path_strs: tuple[str, ...]) → tuple[str, ...]
  scope_prefix: str = ''

    A prefix that will be striped from the scope when parsing commit messages.

    If set, it will cause unscoped commits to be ignored. Use this in tandem with the path_filters option to filter commits by directory and scope. This will be fed into a regular expression so you must escape any special characters that are meaningful in regular expressions (e.g. ., *, ?, +, etc.) if you want to match them literally.

  classmethod validate_scope_prefix(scope_prefix: str) → str