env

Documentation

Overview

Package env provides a middleware handling environment variables

Index

• type Middleware
  • func NewMiddleware() Middleware
  • func NewMiddlewareWithProvider(setenv func(string, string) error, expandEnv func(string) string) Middleware
  • func (envMiddleware Middleware) Apply(run *pipeline.Run, next func(*pipeline.Run), _ *middleware.ExecutionContext)
  • func (envMiddleware Middleware) String() string

Types

type Middleware

type Middleware struct {
	Setenv    func(string, string) error
	ExpandEnv func(string) string
}

Middleware is an environment variable handler

func NewMiddleware

func NewMiddleware() Middleware

NewMiddleware creates a new middleware instance

func NewMiddlewareWithProvider

func NewMiddlewareWithProvider(
	setenv func(string, string) error,
	expandEnv func(string) string,
) Middleware

NewMiddlewareWithProvider creates a new middleware instance with the specified env functions

func (Middleware) Apply

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

String is a human-readable description