git

package

v1.25.1 Latest Latest Go to latest Published: Apr 4, 2024 License: MIT Imports: 15 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 implements the Pipe interface getting and validating the current git repository state

This section is empty.

View Source

var ErrNoGit = errors.New("git not present in PATH")

ErrNoGit happens when git is not present in PATH.

View Source

var ErrNoTag = errors.New("git doesn't contain any tags. Either add a tag or use --snapshot")

ErrNoTag happens if the underlying git repository doesn't contain any tags but no snapshot-release was requested.

View Source

var ErrNotRepository = errors.New("current folder is not a git repository")

ErrNotRepository happens if you try to run goreleaser against a folder which is not a git repository.

func CheckDirty(ctx *context.Context) error

CheckDirty returns an error if the current git repository is dirty.

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

ErrDirty happens when the repo has uncommitted/unstashed changes.

func (e ErrDirty) Error() string

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

ErrWrongRef happens when the HEAD reference is different from the tag being built.

func (e ErrWrongRef) Error() string

type Pipe struct{}

Pipe that sets up git state.

func (Pipe) Run(ctx *context.Context) error

Run the pipe.

func (Pipe) String() string