git

Documentation

Index

• Variables
• func CommitBody(sha string) (string, error)
• 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)
• type BranchConfig
  • func ReadBranchConfig(branch string) (cfg BranchConfig)
• type Commit
  • func Commits(baseRef, headRef string) ([]*Commit, error)
• type Ref
  • func ShowRefs(ref ...string) ([]Ref, error)
• type Remote
  • func AddRemote(name, u 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
• type TrackingRef
  • func (r TrackingRef) String() string

Variables

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

Functions

func CommitBody

func CommitBody(sha string) (string, error)

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

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

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 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 Commit

type Commit struct {
	Sha   string
	Title string
}

func Commits

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

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
	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 (*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

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