git

Documentation

Index

• Variables
• func Config(name string) (string, error)
• func CurrentBranch() (string, error)
• func ParseURL(rawURL string) (u *url.URL, err error)
• func Push(remote string, ref string) error
• func ToplevelDir() (string, error)
• func UncommittedChangeCount() (int, error)
• func VerifyRef(ref string) bool
• type BranchConfig
  • func ReadBranchConfig(branch string) (cfg BranchConfig)
• type Remote
  • func AddRemote(name, initURL, finalURL string) (*Remote, error)
  • func (r *Remote) String() string
• type RemoteSet
  • func Remotes() (RemoteSet, error)
• type SSHAliasMap
  • func ParseSSHConfig() SSHAliasMap
  • func (m SSHAliasMap) Translator() func(*url.URL) *url.URL

Variables

var GitCommand = func(args ...string) *exec.Cmd {
	return exec.Command("git", args...)
}

Functions

func Config

func Config(name string) (string, error)

func CurrentBranch

func CurrentBranch() (string, error)

CurrentBranch reads the checked-out branch for the git repository

func ParseURL

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

ParseURL normalizes git remote urls

func Push

func Push(remote string, ref 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)

func VerifyRef

func VerifyRef(ref string) bool

Types

type BranchConfig

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

func ReadBranchConfig

func ReadBranchConfig(branch string) (cfg BranchConfig)

ReadBranchConfig parses the `branch.BRANCH.(remote|merge)` part of git config

type Remote

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

Remote is a parsed git remote

func AddRemote

func AddRemote(name, initURL, finalURL string) (*Remote, error)

AddRemote adds a new git remote. The initURL is the remote URL with which the automatic fetch is made and finalURL, if non-blank, is set as the remote URL after the fetch.

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 ParseSSHConfig

func ParseSSHConfig() SSHAliasMap

ParseSSHConfig constructs a map of SSH hostname aliases based on user and system configuration files

func (SSHAliasMap) Translator

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

Translator returns a function that applies hostname aliases to URLs