_output

README

output - Output Override

The output middleware manipulates the pipe's output, either processing it using another pipe or replacing it with a fixed value.

Arguments

It takes either of two mutually exclusive string arguments:

Process

The process argument is a string value containing the name of a pipe to be applied to the output.

private:
    some-pipe:
        output: output-processor
        shell:
            run: some-shell-command

    output-processor:
        some: arguments

Text

The text argument is a string value that specifies the pipe's output. If this argument is provided, the pipe's output will be discarded.

private:
    some-pipe:
        input: "This is the new input"
        shell:
            run: some-shell-command

Documentation

Overview

Package _output provides a middleware to overwrite a pipe's output directly

Index

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

Types

type Middleware

type Middleware struct {
}

Middleware is an output interceptor

func NewMiddleware

func NewMiddleware() Middleware

NewMiddleware creates a new middleware instance

func (Middleware) Apply

func (outputMiddleware 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 (outputMiddleware Middleware) String() string

String is a human-readable description