archive

Documentation

Overview

Package archive implements the pipe interface with the intent of archiving and compressing the binaries, readme, and other artifacts. It also provides an Archive interface which represents an archiving format.

Index

• Variables
• func NewEnhancedArchive(a archive.Archive, wrap string) archive.Archive
• type EnhancedArchive
  • func (d EnhancedArchive) Add(f config.File) error
  • func (d EnhancedArchive) Close() error
• type Pipe
  • func (Pipe) Default(ctx *context.Context) error
  • func (Pipe) Run(ctx *context.Context) error
  • func (Pipe) String() string

Variables

var ErrArchiveDifferentBinaryCount = errors.New("archive has different count of built binaries for each platform, which may cause your users confusion. Please make sure all builds used have the same set of goos/goarch/etc or split it into multiple archives")

ErrArchiveDifferentBinaryCount happens when an archive uses several builds which have different goos/goarch/etc sets, causing the archives for some platforms to have more binaries than others. GoReleaser breaks in these cases as it will only cause confusion to other users.

Functions

func NewEnhancedArchive

func NewEnhancedArchive(a archive.Archive, wrap string) archive.Archive

NewEnhancedArchive enhances a pre-existing archive.Archive instance with this pipe specifics.

Types

type EnhancedArchive

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

EnhancedArchive is an archive.Archive implementation which decorates an archive.Archive adding wrap directory support, logging and windows backslash fixes.

func (EnhancedArchive) Add

func (d EnhancedArchive) Add(f config.File) error

Add adds a file.

func (EnhancedArchive) Close

func (d EnhancedArchive) Close() error

Close closes the underlying archive.

type Pipe

type Pipe struct{}

Pipe for archive.

func (Pipe) Default

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

Default sets the pipe defaults.

func (Pipe) Run

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

Run the pipe.

func (Pipe) String

func (Pipe) String() string