git

Documentation

Overview

The git package contains functions for running git commands.

Index

• type Change
• type Commit
• type Repository
  • func New(path string) (*Repository, error)
  • func (r *Repository) CreateTag(hash, name, message string, signed bool) error
  • func (r *Repository) DeleteTags(tags []string) error
  • func (r *Repository) Head() (Commit, error)
  • func (r *Repository) PushTag(tag string, remote string) error
  • func (r *Repository) PushTags(tags []string, remote string) error
  • func (r *Repository) RevList(start, end string, paths ...string) ([]Commit, error)
  • func (r *Repository) RevParse(rev string) (string, error)
  • func (r *Repository) Tags(rev string, prefixes ...string) (tags []string, err error)

Types

type Change

type Change struct {
	SourceName string
	DestName   string
	Action     string
	SourceMode string
	DestMode   string
	SourceSHA  string
	DestSHA    string
}

type Commit

type Commit struct {
	commit.Commit
	Hash    string
	Changes []Change
}

Commit represents a commit in a git repository.

type Repository

type Repository struct {
	GitDir string
	Path   string
	// contains filtered or unexported fields
}

Repository represents a git repository.

func New

func New(path string) (*Repository, error)

New returns a new git Repo. If path is not a git repo, then an error will be returned.

func (*Repository) CreateTag

func (r *Repository) CreateTag(hash, name, message string, signed bool) error

CreateTag tags a commit in a git repo.

If prefix is a non-empty string, then the version will be prefixed with that string.

func (*Repository) DeleteTags

func (r *Repository) DeleteTags(tags []string) error

func (*Repository) Head

func (r *Repository) Head() (Commit, error)

Head returns the commit at HEAD

func (*Repository) PushTag

func (r *Repository) PushTag(tag string, remote string) error

PushTag pushes tag to remote.

func (*Repository) PushTags

func (r *Repository) PushTags(tags []string, remote string) error

PushTags pushes tags to the remote repository remote.

func (*Repository) RevList

func (r *Repository) RevList(start, end string, paths ...string) ([]Commit, error)

RevList returns a slice of commits from start to end.

func (*Repository) RevParse

func (r *Repository) RevParse(rev string) (string, error)

func (*Repository) Tags

func (r *Repository) Tags(rev string, prefixes ...string) (tags []string, err error)

Tags returns all tags that point to ancestors of rev.

rev can be either a revision or a hash.

prefix is a string prefix to filter tags with.