when

Documentation

Overview

Package when provides a middleware that enables conditional execution

Index

• type Middleware
  • func NewMiddleware() Middleware
  • func (whenMiddleware Middleware) Apply(run *pipeline.Run, next func(*pipeline.Run), _ *middleware.ExecutionContext)
  • func (whenMiddleware Middleware) String() string

Types

type Middleware

type Middleware struct {
}

Middleware is a conditional executor

func NewMiddleware

func NewMiddleware() Middleware

NewMiddleware creates a new middleware instance

func (Middleware) Apply

func (whenMiddleware Middleware) Apply(
	run *pipeline.Run,
	next func(*pipeline.Run),
	_ *middleware.ExecutionContext,
)

Apply is where the middleware's logic resides

It adapts the run based on its slice of the run's arguments. It may also trigger side effects such as executing shell commands or full runs of other pipelines. When done, this function should call next in order to continue unwinding the stack.

func (Middleware) String

func (whenMiddleware Middleware) String() string

String is a human-readable description