vcs

Documentation

Overview

Package vcs abstracts version control systems. Currently just git.

Index

• Variables
• type Interface
• type Mock
  • func NewMock() *Mock
  • func (m *Mock) BranchContains(ctx context.Context, commit, branch string) (bool, error)
  • func (m *Mock) CreateTag(ctx context.Context, commit, tag string, opts TagOpts) error
  • func (m *Mock) CurrentBranch(ctx context.Context) (string, error)
  • func (m *Mock) CurrentCommit(ctx context.Context) (string, error)
  • func (m *Mock) DeleteTag(ctx context.Context, commit, tag string) error
  • func (m *Mock) Fetch(ctx context.Context, upstream, ref string) error
  • func (m *Mock) GetMainBranch(ctx context.Context, candidates []string) (string, error)
  • func (m *Mock) Push(ctx context.Context, upstream, ref string, opts PushOpts) error
  • func (m *Mock) ReadCommits(ctx context.Context, query string) ([]*model.Commit, error)
  • func (m *Mock) ReadNameFromRemoteURL(ctx context.Context, upstream string) (string, error)
  • func (m *Mock) ReadTags(ctx context.Context, query string) ([]string, error)
  • func (m *Mock) SetCommits(commits ...*model.Commit) *Mock
  • func (m *Mock) SetTags(tags ...string) *Mock
• type NotFoundError
  • func (e NotFoundError) Error() string
• type PushOpts
• type TagOpts

Variables

var ErrRemoteUnavailable = errors.New("remote not available in repository")

Types

type Interface

type Interface interface {
	Fetch(ctx context.Context, upstream, ref string) error
	Push(ctx context.Context, upstream, ref string, opts PushOpts) error
	ReadCommits(ctx context.Context, query string) ([]*model.Commit, error)
	CreateTag(ctx context.Context, commit, tag string, opts TagOpts) error
	DeleteTag(ctx context.Context, commit, tag string) error
	ReadTags(ctx context.Context, query string) ([]string, error)
	GetMainBranch(ctx context.Context, candidates []string) (string, error)
	CurrentBranch(ctx context.Context) (string, error)
	BranchContains(ctx context.Context, commit, branch string) (bool, error)
	CurrentCommit(ctx context.Context) (string, error)
	ReadNameFromRemoteURL(ctx context.Context, upstream string) (string, error)
}

type Mock

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

func NewMock

func NewMock() *Mock

func (*Mock) BranchContains

func (m *Mock) BranchContains(ctx context.Context, commit, branch string) (bool, error)

func (*Mock) CreateTag

func (m *Mock) CreateTag(ctx context.Context, commit, tag string, opts TagOpts) error

func (*Mock) CurrentBranch

func (m *Mock) CurrentBranch(ctx context.Context) (string, error)

func (*Mock) CurrentCommit

func (m *Mock) CurrentCommit(ctx context.Context) (string, error)

func (*Mock) DeleteTag

func (m *Mock) DeleteTag(ctx context.Context, commit, tag string) error

func (*Mock) Fetch

func (m *Mock) Fetch(ctx context.Context, upstream, ref string) error

func (*Mock) GetMainBranch

func (m *Mock) GetMainBranch(ctx context.Context, candidates []string) (string, error)

func (*Mock) Push

func (m *Mock) Push(ctx context.Context, upstream, ref string, opts PushOpts) error

func (*Mock) ReadCommits

func (m *Mock) ReadCommits(ctx context.Context, query string) ([]*model.Commit, error)

func (*Mock) ReadNameFromRemoteURL

func (m *Mock) ReadNameFromRemoteURL(ctx context.Context, upstream string) (string, error)

func (*Mock) ReadTags

func (m *Mock) ReadTags(ctx context.Context, query string) ([]string, error)

func (*Mock) SetCommits

func (m *Mock) SetCommits(commits ...*model.Commit) *Mock

func (*Mock) SetTags

func (m *Mock) SetTags(tags ...string) *Mock

type NotFoundError

type NotFoundError struct {
	Ref string
}

func (NotFoundError) Error

func (e NotFoundError) Error() string

type PushOpts

type PushOpts struct {
	Tags       bool
	FollowTags bool
}

type TagOpts

type TagOpts struct {
	Message     string
	Author      string
	AuthorEmail string
}