dir

README

dir - Directory Navigator

Arguments

Dir Argument

The dir middleware takes a single string argument indicating the directory in which any commands should be executed on the local machine.

You can specify either a relative or an absolute. Relative paths are evaluated with respect to the directory in which the pipedream command is executed.

Note that other middleware (like ssh and docker) might cause commands to take effect on remote machines. The dir middleware only controls the working directory for the local command. Use the dir argument of the shell middleware to control the working directory on the remote machine.

Relative Path

private:
    some-pipe:
        # any shell commands will be executed in the specified subdirectory of the directory in which pipedream is executed
        dir: some/relative/path

    some-other-pipe:
        # this has the same effect
        dir: ./some/relative/path

Absolute Path

private:
    some-pipe:
        # any shell commands will be executed in the specified directory
        dir: /some/absolute/path

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