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 Env
  • func (e Env) Strings() []string
• type GitInfo
• type Semver
• type TokenType

Types

type Context

type Context struct {
	ctx.Context
	Config        config.Project
	Env           Env
	Token         string
	TokenType     TokenType
	Git           GitInfo
	Artifacts     artifact.Artifacts
	ReleaseNotes  string
	ReleaseHeader string
	ReleaseFooter string
	Version       string
	Snapshot      bool
	SkipPublish   bool
	SkipSign      bool
	SkipValidate  bool
	RmDist        bool
	PreRelease    bool
	Parallelism   int
	Semver        Semver
}

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 Env

type Env map[string]string

Env is the environment variables

func (Env) Strings

func (e Env) Strings() []string

Strings returns the current environment as a list of strings, suitable for os executions.

type GitInfo

type GitInfo struct {
	CurrentTag  string
	Commit      string
	ShortCommit string
	FullCommit  string
	URL         string
}

GitInfo includes tags and diffs used in some point

type Semver

type Semver struct {
	Major      uint64
	Minor      uint64
	Patch      uint64
	Prerelease string
}

Semver represents a semantic version

type TokenType

type TokenType string

TokenType is either github or gitlab

const (
	// TokenTypeGitHub defines github as type of the token
	TokenTypeGitHub TokenType = "github"
	// TokenTypeGitLab defines gitlab as type of the token
	TokenTypeGitLab TokenType = "gitlab"
	// TokenTypeGitea defines gitea as type of the token
	TokenTypeGitea TokenType = "gitea"
)