git

Documentation

Index

• Variables
• func BranchNameFromHead(head string) (string, error)
• func FindRoot(path string) (string, error)
• func IsAvailable() bool
• type Cmd
  • func Command(args ...string) *Cmd
  • func (c *Cmd) Execute() (string, error)
  • func (c *Cmd) ExecuteAt(path string) (string, error)
• type CommitMessage
  • func ParseCommitMessage(text string) (CommitMessage, error)
  • func (m CommitMessage) Bytes() []byte
  • func (m CommitMessage) String() string
• type Repository
  • func NewRepository(root string) *Repository
  • func OpenRepository(path string) (*Repository, error)
  • func (r *Repository) BranchName() (string, error)
  • func (r *Repository) CommitMessage() (CommitMessage, error)
  • func (r *Repository) HooksDir() (string, error)
  • func (r *Repository) Path() string
  • func (r *Repository) SetCommitMessage(m CommitMessage) error

Variables

var (
	// ErrEmptyMessage is returned when commit message is empty
	ErrEmptyMessage = errors.New("commit message is empty")
	// ErrCommitNotFound is returned when commit file is not found
	ErrCommitNotFound = errors.New("commit file is not found")
)

var ErrBranchNotFound = errors.New("HEAD is not on a branch")

ErrBranchNotFound is returned when repository HEAD is in detached state

var ErrCommandFailed = fmt.Errorf("command failed")

ErrCommandFailed is returned when git command execution fails

var ErrHeadNotFound = errors.New("HEAD file is not found")

ErrHeadNotFound is returned when HEAD file is not found

Functions

func BranchNameFromHead

func BranchNameFromHead(head string) (string, error)

BranchNameFromHead extracts branch name from raw HEAD content

func FindRoot

func FindRoot(path string) (string, error)

FindRoot returns root of git repository

func IsAvailable

func IsAvailable() bool

IsAvailable returns true if git is available in PATH

Types

type Cmd

type Cmd struct {
	// Cmd is native git command instance
	*exec.Cmd
	// contains filtered or unexported fields
}

Cmd represents git command

func Command

func Command(args ...string) *Cmd

Command returns new git command

func (*Cmd) Execute

func (c *Cmd) Execute() (string, error)

Execute executes git command

func (*Cmd) ExecuteAt

func (c *Cmd) ExecuteAt(path string) (string, error)

ExecuteAt executes git command at given path

type CommitMessage

type CommitMessage struct {
	Title string
	Body  string
}

CommitMessage represents commit message

func ParseCommitMessage

func ParseCommitMessage(text string) (CommitMessage, error)

ParseCommitMessage parses commit message to parts

func (CommitMessage) Bytes

func (m CommitMessage) Bytes() []byte

Bytes returns byte representation of commit message

func (CommitMessage) String

func (m CommitMessage) String() string

String returns string representation of commit message

type Repository

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

Repository represents git repository

func NewRepository

func NewRepository(root string) *Repository

NewRepository returns a new Repository instance

func OpenRepository

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

OpenRepository returns a new Repository instance with root of git repository.

func (*Repository) BranchName

func (r *Repository) BranchName() (string, error)

BranchName returns current branch name. If repository is in detached state, returns error

func (*Repository) CommitMessage

func (r *Repository) CommitMessage() (CommitMessage, error)

CommitMessage reads current commit message and parses it to title and body.

func (*Repository) HooksDir

func (r *Repository) HooksDir() (string, error)

HooksDir returns path to the repo hooks directory

func (*Repository) Path

func (r *Repository) Path() string

Path returns path to the git repository

func (*Repository) SetCommitMessage

func (r *Repository) SetCommitMessage(m CommitMessage) error

SetCommitMessage writes commit message to the repository.