artifact

package

v0.9.2 Latest Latest Go to latest Published: Mar 28, 2024 License: Apache-2.0 Imports: 21 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/wavesoftware/go-magetasks

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func BuildKey(artifact config.Artifact) config.ResultKey
func ConfigureDefaults()
func ImageReferenceOf(img Image) config.Resolver
func PublishKey(artifact config.Artifact) config.ResultKey
type Binary
- func (b Binary) GetType() string
type BinaryBuilder
- func (bb BinaryBuilder) Accepts(artifact config.Artifact) bool
- func (bb BinaryBuilder) Build(artifact config.Artifact, notifier config.Notifier) config.Result
type Image
- func (i Image) GetType() string
type KoBuilder
- func (kb KoBuilder) Accepts(artifact config.Artifact) bool
- func (kb KoBuilder) Build(artifact config.Artifact, notifier config.Notifier) config.Result
type KoPublisher
- func (kp KoPublisher) Accepts(artifact config.Artifact) bool
- func (kp KoPublisher) Publish(artifact config.Artifact, notifier config.Notifier) config.Result
type KoPublisherConfigurator
type ListPublisher
- func (l ListPublisher) Accepts(artifact config.Artifact) bool
- func (l ListPublisher) Publish(artifact config.Artifact, notifier config.Notifier) config.Result
type Platform

Constants ¶

View Source

const (
	// ResultBuilt is used to cache results of building the artifacts.
	ResultBuilt = "built"

	// ResultPublication is used to cache results of publication of artifacts.
	ResultPublication = "publication"

	// BinariesByPlatform is used to assign built binary to a platform.
	BinariesByPlatform = "binary.by-platform"
)

View Source

const (
	// ArtifactsBuilt is used to list artifacts that was built.
	ArtifactsBuilt = "artifacts.built"
)

Variables ¶

View Source

var (
	// ErrGoBuildFailed when go fails to build the project.
	ErrGoBuildFailed = errors.New("go build failed")

	// ErrInvalidArtifact when invalid type of artifact is given.
	ErrInvalidArtifact = errors.New("invalid artifact")
)

View Source

var ErrKoFailed = errors.New("ko failed")

ErrKoFailed when th Google's ko fails to build.

View Source

var ErrMisconfiguration = errors.New("project configuration is faulty")

ErrMisconfiguration when the project configuration faulty.

Functions ¶

func BuildKey ¶

func BuildKey(artifact config.Artifact) config.ResultKey

BuildKey returns the config.ResultKey for a build command.

func ConfigureDefaults ¶

func ConfigureDefaults()

ConfigureDefaults will configure default builders and publishers to be used.

func ImageReferenceOf ¶

func ImageReferenceOf(img Image) config.Resolver

ImageReferenceOf will try to fetch an image reference from image build result.

func PublishKey ¶

func PublishKey(artifact config.Artifact) config.ResultKey

PublishKey returns the config.ResultKey for a publish command.

Types ¶

type Binary ¶

type Binary struct {
	config.Metadata
	Platforms []Platform
}

Binary represents a binary that will be built.

func (Binary) GetType ¶

func (b Binary) GetType() string

type BinaryBuilder ¶

type BinaryBuilder struct{}

BinaryBuilder is a regular binary Golang builder.

func (BinaryBuilder) Accepts ¶

func (bb BinaryBuilder) Accepts(artifact config.Artifact) bool

func (BinaryBuilder) Build ¶

func (bb BinaryBuilder) Build(artifact config.Artifact, notifier config.Notifier) config.Result

type Image ¶

type Image struct {
	config.Metadata
	Labels        map[string]config.Resolver
	Architectures []platform.Architecture
}

Image is an OCI image that will be built from a binary.

func (Image) GetType ¶

func (i Image) GetType() string

type KoBuilder ¶

type KoBuilder struct{}

KoBuilder builds images with Google's KO.

func (KoBuilder) Accepts ¶

func (kb KoBuilder) Accepts(artifact config.Artifact) bool

func (KoBuilder) Build ¶

func (kb KoBuilder) Build(artifact config.Artifact, notifier config.Notifier) config.Result

type KoPublisher ¶

type KoPublisher struct {
	Configurators []KoPublisherConfigurator
}

KoPublisher publishes images with Google's KO.

func (KoPublisher) Accepts ¶

func (kp KoPublisher) Accepts(artifact config.Artifact) bool

func (KoPublisher) Publish ¶

func (kp KoPublisher) Publish(artifact config.Artifact, notifier config.Notifier) config.Result

type KoPublisherConfigurator ¶

type KoPublisherConfigurator func(*options.PublishOptions) error

KoPublisherConfigurator is used to configure the publish options for KO.

type ListPublisher ¶

type ListPublisher struct {
	FilePath         string
	ResultsRetriever func(config.Artifact) *config.Result
}

ListPublisher will output built artifacts as a "\n" delimited list in a result file.

func (ListPublisher) Accepts ¶

func (l ListPublisher) Accepts(artifact config.Artifact) bool

func (ListPublisher) Publish ¶

func (l ListPublisher) Publish(artifact config.Artifact, notifier config.Notifier) config.Result

type Platform ¶

type Platform struct {
	platform.OS
	platform.Architecture
}

Platform to built binary for.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
image
platform

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