pipe

Documentation

Overview

Package pipe provides a middleware to execute several commands in sequence

Index

• type Middleware
  • func NewMiddleware() Middleware
  • func (pipeMiddleware Middleware) Apply(run *pipeline.Run, next func(pipelineRun *pipeline.Run), ...)
  • func (pipeMiddleware Middleware) String() string

Types

type Middleware

type Middleware struct{}

Middleware is an invocation chainer

func NewMiddleware

func NewMiddleware() Middleware

NewMiddleware creates a new middleware instance

func (Middleware) Apply

func (pipeMiddleware Middleware) Apply(
	run *pipeline.Run,
	next func(pipelineRun *pipeline.Run),
	executionContext *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 (pipeMiddleware Middleware) String() string