context

Documentation

Overview

Package context provides gorelease context which is passed through the pipeline.

The context extends the standard library context and add a few more fields and other things, so pipes can gather data provided by previous pipes without really knowing each other.

Index

• type Binary
• type Context
  • func New(config config.Project) *Context
  • func (ctx *Context) AddArtifact(file string)
  • func (ctx *Context) AddBinary(platform, folder, name, path string)
  • func (ctx *Context) AddDocker(image string)
• type GitInfo

Types

type Binary

type Binary struct {
	Name, Path string
}

Binary with pretty name and path

type Context

type Context struct {
	ctx.Context
	Config       config.Project
	Env          map[string]string
	Token        string
	Git          GitInfo
	Binaries     map[string]map[string][]Binary
	Artifacts    []string
	Dockers      []string
	ReleaseNotes string
	Version      string
	Validate     bool
	Publish      bool
	Snapshot     bool
	RmDist       bool
	Debug        bool
	Parallelism  int
}

Context carries along some data through the pipes

func New

func New(config config.Project) *Context

New context

func (*Context) AddArtifact

func (ctx *Context) AddArtifact(file string)

AddArtifact adds a file to upload list

func (*Context) AddBinary

func (ctx *Context) AddBinary(platform, folder, name, path string)

AddBinary adds a built binary to the current context

func (*Context) AddDocker

func (ctx *Context) AddDocker(image string)

AddDocker adds a docker image to the docker images list

type GitInfo

type GitInfo struct {
	CurrentTag string
	Commit     string
}

GitInfo includes tags and diffs used in some point