git

Documentation

Overview

Package git contains various commands that shell out to git

Package git contains various commands that shell out to git

Index

• Constants
• Variables
• func CurrentBranch() (string, error)
• func CurrentRemote() (string, error)
• func FormatGitDate(tm time.Time) string
• func LsRemote(remote, remoteRef string) (string, error)
• func ParseGitDate(str string) (time.Time, error)
• func UpdateIndex(file string) error
• type CommitSummary
  • func GetCommitSummary(commit string) (*CommitSummary, error)
• type Ref
  • func CurrentRef() (*Ref, error)
  • func CurrentRemoteRef() (*Ref, error)
  • func RecentBranches(since time.Time, includeRemoteBranches bool, onlyRemote string) ([]*Ref, error)
  • func ResolveRef(ref string) (*Ref, error)
• type RefType
  • func ParseRefToTypeAndName(fullref string) (t RefType, name string)

Constants

const (
	RefTypeLocalBranch  = RefType(iota)
	RefTypeRemoteBranch = RefType(iota)
	RefTypeLocalTag     = RefType(iota)
	RefTypeRemoteTag    = RefType(iota)
	RefTypeHEAD         = RefType(iota) // current checkout
	RefTypeOther        = RefType(iota) // stash or unknown
)

Variables

var Config = &gitConfig{}

Functions

func CurrentBranch

func CurrentBranch() (string, error)

func CurrentRemote

func CurrentRemote() (string, error)

func FormatGitDate

func FormatGitDate(tm time.Time) string

FormatGitDate converts a Go date into a git command line format date

func LsRemote

func LsRemote(remote, remoteRef string) (string, error)

func ParseGitDate

func ParseGitDate(str string) (time.Time, error)

Parse a Git date formatted in ISO 8601 format (%ci/%ai)

func UpdateIndex

func UpdateIndex(file string) error

Types

type CommitSummary

type CommitSummary struct {
	Sha            string
	ShortSha       string
	Parents        []string
	CommitDate     time.Time
	AuthorDate     time.Time
	AuthorName     string
	AuthorEmail    string
	CommitterName  string
	CommitterEmail string
	Subject        string
}

Some top level information about a commit (only first line of message)

func GetCommitSummary

func GetCommitSummary(commit string) (*CommitSummary, error)

Get summary information about a commit

type Ref

type Ref struct {
	Name string
	Type RefType
	Sha  string
}

A git reference (branch, tag etc)

func CurrentRef

func CurrentRef() (*Ref, error)

func CurrentRemoteRef

func CurrentRemoteRef() (*Ref, error)

func RecentBranches

func RecentBranches(since time.Time, includeRemoteBranches bool, onlyRemote string) ([]*Ref, error)

RecentBranches returns branches with commit dates on or after the given date/time Return full Ref type for easier detection of duplicate SHAs etc since: refs with commits on or after this date will be included includeRemoteBranches: true to include refs on remote branches onlyRemote: set to non-blank to only include remote branches on a single remote

func ResolveRef

func ResolveRef(ref string) (*Ref, error)

type RefType

type RefType int

func ParseRefToTypeAndName

func ParseRefToTypeAndName(fullref string) (t RefType, name string)

Get the type & name of a git reference