CommitResult

Result of Repo.commit.

Usage

Source

CommitResult(
    message,
    pinned=dict(),
    unrecoverable=list(),
    unchanged=list(),
    vcs_commit=None
)

Parameter Attributes

message: str

The commit message.

pinned: dict[str, Pin | None] = dict()

Objects whose state was recorded: the Pin created, or None for Addressable objects (recorded without a native ref).

unrecoverable: list[str] = list()

Observed-tier objects recorded with recoverable = False.

unchanged: list[str] = list()

Objects skipped because their state was already recorded.

vcs_commit: str | None = None

Commit id of the VCS commit, or None if nothing changed / vcs=False.