git

Documentation

Index

• func CheckoutBranch(branch string) error
• func DeleteBranches(branches []string) error
• func ErrNotInRepository(err error) bool
• type Branch
  • func Branches() ([]*Branch, error)
  • func NewBranch(name string) (*Branch, error)
• type BranchType
  • func (bt BranchType) String() string

Functions

func CheckoutBranch

func CheckoutBranch(branch string) error

CheckoutBranch will attempt to checkout the branch with the given name.

func DeleteBranches

func DeleteBranches(branches []string) error

DeleteBranches will attempt to delete branches with the given names in the current repository.

func ErrNotInRepository

func ErrNotInRepository(err error) bool

ErrNotInRepository returns true if the given error occurred because the current working directory is not part of a Git repository.

Types

type Branch

type Branch struct {
	Type        BranchType
	Name        string
	Description string
}

func Branches

func Branches() ([]*Branch, error)

Branches returns a list of Git branches in the current repository.

func NewBranch

func NewBranch(name string) (*Branch, error)

NewBranch constructs a new Branch structure based on the given branch. The branch name must match the name of a branch that exists in the current Git repository. Using the name, the function will gather information about the branch and populate the structure.

type BranchType

type BranchType int

const (
	BranchTypeNormal BranchType = iota
	BranchTypeCurrent
	BranchTypeWorktree
)

func (BranchType) String

func (bt BranchType) String() string