repository

package

v0.0.0-...-af9a2c8 Latest Latest Go to latest Published: Jun 28, 2016 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	RepositoryError = iota // Unused, it will always get returned with an err
	RepositoryCloned
	RepositoryOpened
)

Status codes for Repository object creation

This section is empty.

This section is empty.

type Repository struct {
	sync.Mutex

	*git.Repository
	Config *config.Repo
}

Repository is used to hold the git repository object and it's configuration

func LoadRepos(cfg *config.Config) ([]*Repository, error)

LoadRepos populates Repository slice from configuration. It also handles cloning of the repository if not present

func New(repoBasePath string, repoConfig *config.Repo) (*Repository, int, error)

New is used to construct a new repository object from the configuration

func (r *Repository) Branch() string

Branch returns the branch name

func (r *Repository) CheckRef(ref string) error

CheckRef checks whether a particular ref is part of the repository

func (r *Repository) CheckoutBranch(branch *git.Branch, opts *git.CheckoutOpts) error

CheckoutBranch performs a checkout on a specific branch

func (r *Repository) Clone(path string) error

Clone the repository. Cloning will only checkout tracked branches. A destination path to clone to needs to be provided

func (r *Repository) DiffStatus(ref string) ([]git.DiffDelta, error)

DiffStatus compares the current workdir with a target ref and return the modified files

func (r *Repository) Name() string

Name returns the repository name

func (r *Repository) Pull(branchName string) (git.MergeAnalysis, error)

Pull a repository branch, which is equivalent to a fetch and merge

Path	Synopsis
mock