docker

README

docker - Docker Executor

Arguments

- some-pipeline:
    shell:
        run: "some-command"
    docker: "some-service"

Documentation

Overview

Package docker provides a middleware for execution within a Docker (Compose) container

Index

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

Types

type Middleware

type Middleware struct {
}

Middleware is a Docker (Compose) executor

func NewMiddleware

func NewMiddleware() Middleware

NewMiddleware create a new Middleware instance

func (Middleware) Apply

func (dockerMiddleware 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