cli

Documentation

Index

• Variables
• func New(opts clients.CommonOpts) pipeline.Client
• type Client
  • func (c *Client) Done(ctx context.Context, w pipeline.Walker) error
  • func (c *Client) HandleEvents(events []pipeline.Event) error
  • func (c *Client) PipelineWalkFunc(w pipeline.Walker, wf pipeline.StepWalkFunc) func(context.Context, ...pipeline.Pipeline) error
  • func (c *Client) StepWalkFunc(ctx context.Context, steps ...pipeline.Step) error
  • func (c *Client) Validate(step pipeline.Step) error

Variables

var (
	ErrorCLIStepHasImage = errors.New("step has a docker image specified. This may cause unexpected results if ran with the CLI client. The `-client=docker` flag is likely more suitable")
)

var KnownValues = map[state.Argument]func(*state.State) error{
	pipeline.ArgumentRemoteURL:  setCurrentRemote,
	pipeline.ArgumentCommitRef:  setCurrentCommit,
	pipeline.ArgumentBranch:     setCurrentBranch,
	pipeline.ArgumentWorkingDir: setWorkingDir,
	pipeline.ArgumentSourceFS:   setSourceFS,
	pipeline.ArgumentBuildID:    setBuildID,
}

KnownValues are URL values that we know how to retrieve using the command line.

Functions

func New

func New(opts clients.CommonOpts) pipeline.Client

Types

type Client

type Client struct {
	Opts clients.CommonOpts
	Log  *logrus.Logger
}

The Client is used when interacting with a scribe pipeline using the scribe CLI. In order to emulate what happens in a remote environment, the steps are put into a queue before being ran.

func (*Client) Done

func (c *Client) Done(ctx context.Context, w pipeline.Walker) error

func (*Client) HandleEvents

func (c *Client) HandleEvents(events []pipeline.Event) error

func (*Client) PipelineWalkFunc

func (c *Client) PipelineWalkFunc(w pipeline.Walker, wf pipeline.StepWalkFunc) func(context.Context, ...pipeline.Pipeline) error

PipelineWalkFunc walks through the pipelines that the collection provides. Each pipeline is a pipeline of steps, so each will walk through the list of steps using the StepWalkFunc.

func (*Client) StepWalkFunc

func (c *Client) StepWalkFunc(ctx context.Context, steps ...pipeline.Step) error

StepWalkFunc walks through the steps that the collection provides.

func (*Client) Validate

func (c *Client) Validate(step pipeline.Step) error