vcs

Documentation

Overview

Package vcs supports interacting with version control systems.

Index

• Variables
• func MetadataFolder(vcs VCS) string
• type GitRepository
  • func NewGitRepository(dir string) (*GitRepository, error)
  • func (gr *GitRepository) Head() Revision
  • func (gr *GitRepository) Project() string
• type MercurialRepository
  • func NewMercurialRepository(dir string) (*MercurialRepository, error)
  • func (m MercurialRepository) Head() Revision
  • func (m MercurialRepository) Project() string
• type NoRepository
  • func NewNoRepository(dir string) (*NoRepository, error)
  • func (nr *NoRepository) Head() Revision
  • func (nr *NoRepository) Project() string
• type Revision
• type SubversionRepository
  • func NewSubversionRepository(dir string) (*SubversionRepository, error)
  • func (s *SubversionRepository) Head() Revision
  • func (s *SubversionRepository) Project() string
• type System
• type VCS
  • func In(dirname string) (VCS, error)
  • func Nearest(dirname string) (VCS, string, error)
  • func (v VCS) String() string

Variables

var (
	ErrNoVCSInDir   = errors.New("could not find VCS repository in directory")
	ErrNoNearestVCS = errors.New("could not find nearest VCS repository in directory")
)

Errors that occur when finding VCS repositories.

Functions

func MetadataFolder

func MetadataFolder(vcs VCS) string

Types

type GitRepository

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

GitRepository implements the System interface.

func NewGitRepository

func NewGitRepository(dir string) (*GitRepository, error)

NewGitRepository uses the git repository's metadata at dir to identify the codebase.

func (*GitRepository) Head

func (gr *GitRepository) Head() Revision

func (*GitRepository) Project

func (gr *GitRepository) Project() string

type MercurialRepository

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

MercurialRepository implements the System interface.

func NewMercurialRepository

func NewMercurialRepository(dir string) (*MercurialRepository, error)

NewMercurialRepository uses the Mercurial repository's metadata at dir to identify the codebase.

func (MercurialRepository) Head

func (m MercurialRepository) Head() Revision

func (MercurialRepository) Project

func (m MercurialRepository) Project() string

type NoRepository

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

NoRepository implements the System interface. This is used for projects that are not version controlled.

func NewNoRepository

func NewNoRepository(dir string) (*NoRepository, error)

NewNoRepository uses the name of dir and the current time to identify the codebase.

func (*NoRepository) Head

func (nr *NoRepository) Head() Revision

func (*NoRepository) Project

func (nr *NoRepository) Project() string

type Revision

type Revision struct {
	Branch     string
	RevisionID string
}

type SubversionRepository

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

SubversionRepository implements the System interface.

func NewSubversionRepository

func NewSubversionRepository(dir string) (*SubversionRepository, error)

NewSubversionRepository uses the Subversion repository's metadata at dir to identify the codebase.

func (*SubversionRepository) Head

func (s *SubversionRepository) Head() Revision

func (*SubversionRepository) Project

func (s *SubversionRepository) Project() string

type System

type System interface {
	// Project returns the string uniquely identifying this codebase.
	Project() string

	// Head returns the latest revision that is being examined.
	Head() Revision
}

A System represents the current state of a version-controlled repository.

type VCS

type VCS int

VCS represents a type of version control system.

const (
	Subversion VCS
	Git
	Mercurial
	Bazaar
	None
)

func In

func In(dirname string) (VCS, error)

In returns the type of VCS repository rooted at a directory, or ErrNoVCSInDir if none is found.

func Nearest

func Nearest(dirname string) (VCS, string, error)

Nearest returns the type and directory of the nearest VCS repository containing or at dirname, or ErrNoNearestVCS if none is found.

func (VCS) String

func (v VCS) String() string