Skip to content

bumpversion.scm.git ​

Git source control management implementation.

logger ​

python
logger = get_indented_logger(__name__)

Git ​

python
class Git(config: SCMConfig)

Git implementation.

is_available ​

python
def is_available() -> bool

Is the VCS implementation usable?

latest_tag_info ​

python
def latest_tag_info() -> LatestTagInfo

Return information about the latest tag.

add_path ​

python
def add_path(path: Pathlike) -> None

Add a path to the VCS.

get_all_tags ​

python
def get_all_tags() -> List[str]

Return all tags in git.

commit_and_tag ​

python
def commit_and_tag(files: List[Pathlike], context: MutableMapping, dry_run: bool = False) -> None

Commit and tag files to the repository using the configuration.

assert_nondirty ​

python
def assert_nondirty() -> None

Asserts that the repository is not dirty.

Raises

  • DirtyWorkingDirectoryError: If the repository is not clean.

commit ​

python
def commit(context: MutableMapping) -> None

Commit the changes.

update_index ​

python
def update_index() -> None

Update the git index.

commit_info ​

python
def commit_info(config: SCMConfig) -> dict

Get the commit info for the repo.

Parameters

  • config: The source control configuration.

Returns

  • A dictionary containing information about the latest commit.

revision_info ​

python
def revision_info() -> dict

Returns a dictionary containing revision information.

If an error occurs while running the git command, the dictionary values will be set to None.

Returns

  • A dictionary with the following keys: - branch_name: The name of the current branch. - short_branch_name: A 20 lowercase characters of the branch name with special characters removed. - repository_root: The root directory of the Git repository.

tag ​

python
def tag(name: str, sign: bool = False, message: Optional[str] = None) -> None

Create a tag of the new_version in git.

If only name is given, bumpversion uses a lightweight tag. Otherwise, it uses an annotated tag.

Parameters

  • name: The name of the tag
  • sign: True to sign the tag
  • message: An optional message to annotate the tag.

moveable_tag ​

python
def moveable_tag(name: str) -> None

Create a new lightweight tag that should overwrite any previous tags with the same name.

Parameters

  • name: The name of the moveable tag.

assert_nondirty ​

python
def assert_nondirty(allow_dirty_files: Optional[List[str]] = None) -> None

Assert that the working directory is not dirty, ignoring files matching allow_dirty_files.

push_remote ​

python
def push_remote(remote_name: str, ref_name: str, force: bool = False) -> None

Push the ref_name to the remote_name repository, optionally forcing the push.

delete_remote_tag ​

python
def delete_remote_tag(remote_name: str, ref_name: str) -> None

Delete ref_name from remote_name, ignoring missing remote tag errors.

has_remote ​

python
def has_remote(remote_name: str) -> bool

Return True if remote_name exists in the repository remotes.