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 Context
  • func New(config config.Project) *Context
  • func NewWithTimeout(config config.Project, timeout time.Duration) (*Context, ctx.CancelFunc)
  • func Wrap(ctx ctx.Context, config config.Project) *Context
• type GitInfo

Types

type Context

type Context struct {
	ctx.Context
	Config       config.Project
	Env          map[string]string
	Token        string
	Git          GitInfo
	Artifacts    artifact.Artifacts
	ReleaseNotes string
	Version      string
	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 NewWithTimeout

func NewWithTimeout(config config.Project, timeout time.Duration) (*Context, ctx.CancelFunc)

NewWithTimeout new context with the given timeout

func Wrap

func Wrap(ctx ctx.Context, config config.Project) *Context

Wrap wraps an existing context

type GitInfo

type GitInfo struct {
	CurrentTag string
	Commit     string
}

GitInfo includes tags and diffs used in some point