git

package

v0.0.0-...-60d670b Latest Latest Go to latest Published: Jan 21, 2020 License: MIT Imports: 7 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

Package git wraps functionality in the go-git package to manipulate Git repositories

This section is empty.

This section is empty.

func CleanWorktree(worktree *git.Worktree) error

CleanWorktree runs the equivalent of `git clean -xfd .` on the current worktree

func Open(path string) (*git.Repository, error)

Open opens a repository on-disk at the given path. All operations from here-on are performed using the on-disk filesystem.

func WalkTree(fs billy.Filesystem, cb WalkFunc) error

WalkTree will recursively crawl a go-git Worktree and invoke a callback for each file and directory

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

IgnorePattern aliases string to add some additional documentation

func CompileIgnorePattern(pattern string) (*IgnorePattern, error)

CompileIgnorePattern takes a given ignore pattern and attempts to create a Pattern object from it

func (p *IgnorePattern) Matches(path string) bool

Matches returns whether or not a given path matches the Codeowners path pattern

func (p *IgnorePattern) String() string

type Status = git.Status

Status is a re-export of go-git Status

type WalkFunc func(path string, info os.FileInfo, err error) error

WalkFunc is the callback function signature used by WalkTree