action

Documentation

Index

• func ContextWithReleaseParams(ctx context.Context, segment semver.Segment, comment string) context.Context
• func ContextWithSpec(ctx context.Context, s spec.Spec) context.Context
• func ReleaseParamsFromContext(ctx context.Context) (segment semver.Segment, comment string)
• func SpecFromContext(ctx context.Context) spec.Spec
• type Action
  • func NewBuild(ui cui.CUI, workDir string, s spec.Spec) Action
  • func NewRelease(ui cui.CUI, workDir, githubToken string, s spec.Spec) Action
  • func NewUpdate(ui cui.CUI, githubToken string) Action

Functions

func ContextWithReleaseParams

func ContextWithReleaseParams(ctx context.Context, segment semver.Segment, comment string) context.Context

ContextWithReleaseParams returns a new context that has input parameters for Release action.

func ContextWithSpec

func ContextWithSpec(ctx context.Context, s spec.Spec) context.Context

ContextWithSpec returns a new context that has a copy of spec.

func ReleaseParamsFromContext

func ReleaseParamsFromContext(ctx context.Context) (segment semver.Segment, comment string)

ReleaseParamsFromContext retrieves input parameters for Release action from a context. If a parameter is not found, a default value will be returned.

func SpecFromContext

func SpecFromContext(ctx context.Context) spec.Spec

SpecFromContext returns a copy of spec from context. If no spec found, a default (zero) spec will be returned.

Types

type Action

type Action interface {
	Dry(context.Context) error
	Run(context.Context) error
	Revert(context.Context) error
}

Action is an ordered list of steps that can be reverted.

func NewBuild

func NewBuild(ui cui.CUI, workDir string, s spec.Spec) Action

NewBuild creates an instance of Build action.

func NewRelease

func NewRelease(ui cui.CUI, workDir, githubToken string, s spec.Spec) Action

NewRelease creates an instance of Release action.

func NewUpdate

func NewUpdate(ui cui.CUI, githubToken string) Action

NewUpdate creates an instance of Update action.