artifact

Documentation

Overview

Package artifact provides the core artifact storage for goreleaser

Index

• type Artifact
  • func (a Artifact) Checksum() (string, error)
• type Artifacts
  • func New() Artifacts
  • func (artifacts *Artifacts) Add(a Artifact)
  • func (artifacts *Artifacts) Filter(filter Filter) Artifacts
  • func (artifacts Artifacts) GroupByPlatform() map[string][]Artifact
  • func (artifacts Artifacts) List() []Artifact
• type Filter
  • func And(filters ...Filter) Filter
  • func ByGoarch(s string) Filter
  • func ByGoarm(s string) Filter
  • func ByGoos(s string) Filter
  • func ByType(t Type) Filter
  • func Or(filters ...Filter) Filter
• type Type
  • func (t Type) String() string

Types

type Artifact

type Artifact struct {
	Name   string
	Path   string
	Goos   string
	Goarch string
	Goarm  string
	Type   Type
	Extra  map[string]string
}

Artifact represents an artifact and its relevant info

func (Artifact) Checksum

func (a Artifact) Checksum() (string, error)

Checksum calculates the SHA256 checksum of the artifact.

type Artifacts

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

Artifacts is a list of artifacts

func New

func New() Artifacts

New return a new list of artifacts

func (*Artifacts) Add

func (artifacts *Artifacts) Add(a Artifact)

Add safely adds a new artifact to an artifact list

func (*Artifacts) Filter

func (artifacts *Artifacts) Filter(filter Filter) Artifacts

Filter filters the artifact list, returning a new instance. There are some pre-defined filters but anything of the Type Filter is accepted. You can compose filters by using the And and Or filters.

func (Artifacts) GroupByPlatform

func (artifacts Artifacts) GroupByPlatform() map[string][]Artifact

GroupByPlatform groups the artifacts by their platform

func (Artifacts) List

func (artifacts Artifacts) List() []Artifact

List return the actual list of artifacts

type Filter

type Filter func(a Artifact) bool

Filter defines an artifact filter which can be used within the Filter function

func And

func And(filters ...Filter) Filter

And performs an AND between all given filters

func ByGoarch

func ByGoarch(s string) Filter

ByGoarch is a predefined filter that filters by the given goarch

func ByGoarm

func ByGoarm(s string) Filter

ByGoarm is a predefined filter that filters by the given goarm

func ByGoos

func ByGoos(s string) Filter

ByGoos is a predefined filter that filters by the given goos

func ByType

func ByType(t Type) Filter

ByType is a predefined filter that filters by the given type

func Or

func Or(filters ...Filter) Filter

Or performs an OR between all given filters

type Type

type Type int

Type defines the type of an artifact

const (
	// UploadableArchive a tar.gz/zip archive to be uploaded
	UploadableArchive Type = iota
	// UploadableBinary is a binary file to be uploaded
	UploadableBinary
	// Binary is a binary (output of a gobuild)
	Binary
	// LinuxPackage is a linux package generated by nfpm or snapcraft
	LinuxPackage
	// PublishableDockerImage is a Docker image yet to be published
	PublishableDockerImage
	// DockerImage is a published Docker image
	DockerImage
	// Checksum is a checksums file
	Checksum
	// Signature is a signature file
	Signature
)

func (Type) String

func (t Type) String() string