git

Documentation

Overview

Package git implements helpers for interacting with git

Index

• Variables
• func Clone(ctx context.Context, ref, url string) (string, error)
• func GetDefaultBranch(ctx context.Context, path string) (string, error)
• func ListRemote(ctx context.Context, remote string) ([][]string, error)

Variables

var (
	// ErrNoHeadBranch is returned when a repository's HEAD (aka default) branch cannot
	// be determine
	ErrNoHeadBranch = errors.New("failed to find a head branch, does one exist?")

	// ErrNoRemoteHeadBranch is returned when a repository's remote  default/HEAD branch
	// cannot be determined.
	ErrNoRemoteHeadBranch = errors.New("failed to get head branch from remote origin")
)

This block contains errors and regexes

Functions

func Clone

func Clone(ctx context.Context, ref, url string) (string, error)

Clone clone a git repository to a temporary directory and returns the path to the repository. If ref is empty, the default branch will be used.

func GetDefaultBranch

func GetDefaultBranch(ctx context.Context, path string) (string, error)

GetDefaultBranch determines the default/HEAD branch for a given git repository.

func ListRemote

func ListRemote(ctx context.Context, remote string) ([][]string, error)

ListRemote returns a list of all remotes as shown from running 'git ls-remote'.