git_interface.symbolic_ref

Methods for using git symbolic-ref command

async git_interface.symbolic_ref.change_active_branch(git_repo, branch)

Change the active (HEAD) reference

param git_repo:

Path to the repo

param branch:

The branch name to use

raises UnknownRefException:

Unknown reference given

raises GitException:

Error to do with git

Parameters:

• git_repo (Path | str)

• branch (str)

async git_interface.symbolic_ref.change_symbolic_ref(git_repo, name, ref)

Change a symbolic ref in repo

param git_repo:

Path to the repo

param name:

The name (for example HEAD)

param ref:

The reference

raises UnknownRefException:

Unknown reference given

raises GitException:

Error to do with git

Parameters:

• git_repo (Path | str)

• name (str)

• ref (str)

async git_interface.symbolic_ref.delete_symbolic_ref(git_repo, name)

Delete a symbolic ref in repo

param git_repo:

Path to the repo

param name:

The name (for example HEAD)

raises UnknownRefException:

Unknown reference given

raises GitException:

Error to do with git

Parameters:

• git_repo (Path | str)

• name (str)

async git_interface.symbolic_ref.get_active_branch(git_repo)

Get the active (HEAD) reference

param git_repo:

Path to the repo

raises UnknownRefException:

Unknown reference given

raises GitException:

Error to do with git

Parameters:

git_repo (Path | str)

Return type:

str

async git_interface.symbolic_ref.get_symbolic_ref(git_repo, name)

Get a symbolic ref in repo

param git_repo:

Path to the repo

param name:

The name (for example HEAD)

raises UnknownRefException:

Unknown reference given

raises GitException:

Error to do with git

Parameters:

• git_repo (Path | str)

• name (str)

Return type:

str