Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# semantic_release.gitproject module

Module for git related operations.

class semantic_release.gitproject.GitProject(directory: Path | str = '.', commit_author: Actor | None = None, credential_masker: MaskingFilter | None = None)

  Bases: `object`

  git_add(paths: Sequence[Path | str], force: bool = False, strict: bool = False, noop: bool = False) → None
  git_commit(message: str, date: int | None = None, commit_all: bool = False, no_verify: bool = False, noop: bool = False) → None
  git_push_branch(remote_url: str, branch: str, noop: bool = False) → None
  git_push_tag(remote_url: str, tag: str, noop: bool = False) → None
  git_tag(tag_name: str, message: str, isotimestamp: str, noop: bool = False) → None
  is_dirty() → bool
  property logger: Logger
  property project_root: Path