git

Documentation

Index

• Variables
• func AddUpstreamRemote(upstreamURL, cloneDir string, branches []string) error
• func CheckoutBranch(branch string) error
• func Cluster(name string) (string, error)
• func CommitBody(sha string) (string, error)
• func CurrentBranch() (string, error)
• func DeleteLocalBranch(branch string) error
• func GitCommand(args ...string) (*exec.Cmd, error)
• func HasLocalBranch(branch string) bool
• func IsURL(u string) bool
• func ParseURL(rawURL string) (u *url.URL, err error)
• func Push(remote string, ref string, cmdOut, cmdErr io.Writer) error
• func RunClone(cloneURL string, args []string) (target string, err error)
• func SetRemoteResolution(name, resolution string) error
• func ToplevelDir() (string, error)
• func UncommittedChangeCount() (int, error)
• type BranchCluster
  • func ReadBranchCluster(branch string) (cfg BranchCluster)
• type Commit
  • func Commits(baseRef, headRef string) ([]*Commit, error)
  • func LastCommit() (*Commit, error)
• type NotInstalled
  • func (e *NotInstalled) Error() string
• type Ref
  • func ShowRefs(ref ...string) ([]Ref, error)
• type Remote
  • func AddRemote(name, u string) (*Remote, error)
  • func NewRemote(name string, u string) *Remote
  • func (r *Remote) String() string
• type RemoteSet
  • func Remotes() (RemoteSet, error)
• type SSHAliasMap
  • func ParseSSHCluster() SSHAliasMap
  • func (m SSHAliasMap) Translator() func(*url.URL) *url.URL
• type TrackingRef
  • func (r TrackingRef) String() string

Variables

var ErrNotOnAnyBranch = errors.New("git: not on any branch")

ErrNotOnAnyBranch indicates that the user is in detached HEAD state

Functions

func AddUpstreamRemote

func AddUpstreamRemote(upstreamURL, cloneDir string, branches []string) error

func CheckoutBranch

func CheckoutBranch(branch string) error

func Cluster

func Cluster(name string) (string, error)

func CommitBody

func CommitBody(sha string) (string, error)

func CurrentBranch

func CurrentBranch() (string, error)

CurrentBranch reads the checked-out branch for the git repository

func DeleteLocalBranch

func DeleteLocalBranch(branch string) error

func GitCommand

func GitCommand(args ...string) (*exec.Cmd, error)

func HasLocalBranch

func HasLocalBranch(branch string) bool

func IsURL

func IsURL(u string) bool

func ParseURL

func ParseURL(rawURL string) (u *url.URL, err error)

ParseURL normalizes git remote urls

func Push

func Push(remote string, ref string, cmdOut, cmdErr io.Writer) error

Push publishes a git ref to a remote and sets up upstream Clusteruration

func RunClone

func RunClone(cloneURL string, args []string) (target string, err error)

func SetRemoteResolution

func SetRemoteResolution(name, resolution string) error

func ToplevelDir

func ToplevelDir() (string, error)

ToplevelDir returns the top-level directory path of the current repository

func UncommittedChangeCount

func UncommittedChangeCount() (int, error)

Types

type BranchCluster

type BranchCluster struct {
	RemoteName string
	RemoteURL  *url.URL
	MergeRef   string
}

func ReadBranchCluster

func ReadBranchCluster(branch string) (cfg BranchCluster)

ReadBranchCluster parses the `branch.BRANCH.(remote|merge)` part of git Cluster

type Commit

type Commit struct {
	Sha   string
	Title string
}

func Commits

func Commits(baseRef, headRef string) ([]*Commit, error)

func LastCommit

func LastCommit() (*Commit, error)

type NotInstalled

type NotInstalled struct {
	// contains filtered or unexported fields
}

func (*NotInstalled) Error

func (e *NotInstalled) Error() string

type Ref

type Ref struct {
	Hash string
	Name string
}

Ref represents a git commit reference

func ShowRefs

func ShowRefs(ref ...string) ([]Ref, error)

ShowRefs resolves fully-qualified refs to commit hashes

type Remote

type Remote struct {
	Name     string
	Resolved string
	FetchURL *url.URL
	PushURL  *url.URL
}

Remote is a parsed git remote

func AddRemote

func AddRemote(name, u string) (*Remote, error)

AddRemote adds a new git remote and auto-fetches objects from it

func NewRemote

func NewRemote(name string, u string) *Remote

func (*Remote) String

func (r *Remote) String() string

type RemoteSet

type RemoteSet []*Remote

RemoteSet is a slice of git remotes

func Remotes

func Remotes() (RemoteSet, error)

Remotes gets the git remotes set for the current repo

type SSHAliasMap

type SSHAliasMap map[string]string

SSHAliasMap encapsulates the translation of SSH hostname aliases

func ParseSSHCluster

func ParseSSHCluster() SSHAliasMap

ParseSSHCluster constructs a map of SSH hostname aliases based on user and system Clusteruration files

func (SSHAliasMap) Translator

func (m SSHAliasMap) Translator() func(*url.URL) *url.URL

Translator returns a function that applies hostname aliases to URLs

type TrackingRef

type TrackingRef struct {
	RemoteName string
	BranchName string
}

TrackingRef represents a ref for a remote tracking branch

func (TrackingRef) String

func (r TrackingRef) String() string