releaser

Documentation

Overview

Package releaser aids with publishing your Go binaries efficiently and in a consistent way.

Index

• type PublishParameters
• type ReleaseParameters
• type Releaser
  • func New(ctx context.Context) (*Releaser, error)
  • func NewWithClient(client *s3.Client) *Releaser
  • func (r *Releaser) Publish(ctx context.Context, params PublishParameters) error
  • func (r *Releaser) Release(ctx context.Context, params ReleaseParameters) error

Types

type PublishParameters

type PublishParameters struct {
	Path    string
	Bucket  string
	App     string
	Version string

	// IncludeFilter optionally allows filtering the files to be uploaded
	IncludeFilter func(path string, info os.FileInfo) bool

	// Tags optionally allows bucket tags to be applied
	Tags map[string]string
}

type ReleaseParameters

type ReleaseParameters struct {
	Bucket  string
	App     string
	Version string

	// Environment optionally allows specifying the environment, defaults to "release"
	Environment string

	// Tags optionally allows bucket tags to be applied
	Tags map[string]string
}

type Releaser

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

func New

func New(ctx context.Context) (*Releaser, error)

func NewWithClient

func NewWithClient(client *s3.Client) *Releaser

func (*Releaser) Publish

func (r *Releaser) Publish(ctx context.Context, params PublishParameters) error

func (*Releaser) Release

func (r *Releaser) Release(ctx context.Context, params ReleaseParameters) error