dir

README

dir - Directory Navigator

Arguments

- some-pipeline:
    shell:
        run: "some-command-with-possible-stderr-output"
    dir: ""

Documentation

Overview

Package dir provides a middleware for changing the current working directory

Index

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

Types

type Middleware

type Middleware struct {
	WorkingDir string
	DirChanger func(string) error
}

Middleware is a directory navigator

func NewMiddleware

func NewMiddleware() Middleware

NewMiddleware creates a new Middleware instance

func (Middleware) Apply

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

String is a human-readable description