repository

package

v0.0.0-...-0eee5d1 Latest Latest Go to latest Published: Oct 21, 2019 License: Apache-2.0 Imports: 3 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

Repository

github.com/multi-repo-docs-versioning/docs-manager

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Repository ¶

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

Repository data structure to represent a repository information

func (*Repository) Build ¶

func (repo *Repository) Build() Repository

Build build a Repository instance

func (*Repository) CheckOutTag ¶

func (repo *Repository) CheckOutTag() error

CheckOut check out a

func (*Repository) Clone ¶

func (repo *Repository) Clone() error

Clone clones a repo based on a given url and a path

func (*Repository) GetTag ¶

func (repo *Repository) GetTag() (*plumbing.Reference, error)

GetTag get a repo tag reference based on a given tag name

func (*Repository) SetCloneOptions ¶

func (repo *Repository) SetCloneOptions(cloneOptions git.CloneOptions) RepositoryBuilder

SetCloneOptions set git clone options

func (*Repository) SetGitRepo ¶

func (repo *Repository) SetGitRepo(gitRepo *git.Repository) RepositoryBuilder

SetGitRepo set git repo

func (*Repository) SetPath ¶

func (repo *Repository) SetPath(path string) RepositoryBuilder

SetPath set repo path

func (*Repository) SetTagName ¶

func (repo *Repository) SetTagName(tagName string) RepositoryBuilder

SetTagName set the git repo tag name

type RepositoryBuilder ¶

type RepositoryBuilder interface {
	SetPath(string) RepositoryBuilder
	SetCloneOptions(git.CloneOptions) RepositoryBuilder
	SetGitRepo(*git.Repository) RepositoryBuilder
	SetTagName(string) RepositoryBuilder
	Build() Repository
}

RepositoryBuilder repository builder interface

func New ¶

func New() RepositoryBuilder

New Creates an instance of repository builder

Source Files ¶

View all Source files

repository.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL