artifact

Documentation

Overview

Package artifact define abstract artifacts.

Index

• Variables
• func ValidateName(name string) error
• func ValidateVersion(ver string) error
• type Artifact
  • func New(name, version string) (*Artifact, error)
  • func ParseRef(artifactRef string) (*Artifact, error)

Variables

var (
	ErrInvalidName    = errors.New(`invalid artifact name (must match "[a-z]+[a-z0-9-_]*)"`)
	ErrInvalidVersion = errors.New(`invalid artifact version (must be a valid semver string)`)
	ErrInvalidRef     = errors.New(`invalid artifact reference (must be in the format "name:version")`)
)

Artifacts errors.

Functions

func ValidateName

func ValidateName(name string) error

ValidateName returns an error if the given name is not a valid artifact name.

func ValidateVersion

func ValidateVersion(ver string) error

ValidateVersion returns an error if the given name is not a valid artifact version.

Artifact version must be a semver string (see https://semver.org/).

Types

type Artifact

type Artifact struct {
	Name    string
	Version string
}

Artifact represents a generic artifact release.

func New

func New(name, version string) (*Artifact, error)

New returns a new valid Artifact.

Return an error if the given name or version are not valid.

func ParseRef

func ParseRef(artifactRef string) (*Artifact, error)

ParseRef returns a new valid Artifact from a given reference in the "name:version" format.

Return an error if the given reference is not valid.