gitcheck

Documentation

Index

• Variables
• type ErrDetachedHead
  • func (e ErrDetachedHead) Error() string
• type ErrDirty
  • func (e ErrDirty) Error() string
• type ErrShallowClone
  • func (e ErrShallowClone) Error() string
• type Task
  • func (t Task) Run(ctx *context.Context) error
  • func (t Task) Skip(_ *context.Context) bool
  • func (t Task) String() string

Variables

var (
	// ErrGitMissing is raised if git is not detected on the current $PATH
	ErrGitMissing = errors.New("git is not currently installed under $PATH")

	// ErrNoRepository is raised if the current directory is not a recognised git repository
	ErrNoRepository = errors.New("current working directory is not a git repository")
)

Types

type ErrDetachedHead

type ErrDetachedHead struct{}

ErrDetachedHead is raised if the git repository is in a detached state, which prevents some of the functionality of uplift from working correctly

func (ErrDetachedHead) Error

func (e ErrDetachedHead) Error() string

Error returns a formatted message of the current error

type ErrDirty

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

ErrDirty is raised when a git repository has un-committed and/or un-staged changes

func (ErrDirty) Error

func (e ErrDirty) Error() string

Error returns a formatted message of the current error

type ErrShallowClone

type ErrShallowClone struct{}

ErrShallowClone is raised if the git repository is from a shallow clone, which prevents some of the functionality of uplift from working correctly

func (ErrShallowClone) Error

func (e ErrShallowClone) Error() string

Error returns a formatted message of the current error

type Task

type Task struct{}

Task for detecting if uplift is being run within a recognised git repository

func (Task) Run

func (t Task) Run(ctx *context.Context) error

Run the task

func (Task) Skip

func (t Task) Skip(_ *context.Context) bool

Skip running the task

func (Task) String

func (t Task) String() string

String generates a string representation of the task