pin

Documentation

Index

• Variables
• func Read(path string) (version.Version, error)
• func Remove(path string) error
• func VersionAt(ctx context.Context, storePath, path string) (version.Version, error)
• func Write(v version.Version, path string) error

Variables

var (
	ErrInvalidPath = errors.New("invalid file path")
	ErrMissingPath = errors.New("missing file path")
)

var (
	ErrMissingPin     = errors.New("missing version pin")
	ErrUnexpectedFile = errors.New("unexpected file")
)

Functions

func Read

func Read(path string) (version.Version, error)

Parses a 'Version' from the specified pin file.

func Remove

func Remove(path string) error

Deletes the specified pin file if it exists.

func VersionAt

func VersionAt(ctx context.Context, storePath, path string) (version.Version, error)

Resolves a version for the specified directory. This function starts by looking for a pin file in the specified directory or any ancestor directories. If none are found then globally-pinned version is checked.

func Write

func Write(v version.Version, path string) error

Writes a 'Version' to the specified pin file path.

NOTE: This function will fail if any directories along the path do not exist.