cmdutil

Documentation

Overview

Package cmdutil provides utility functions and types for working with the 'scribe' CLI.

Index

• func NotifySignals(c chan os.Signal)
• func PipelineCommand(opts PipelineCommandOpts) ([]string, error)
• func StepCommand(opts CommandOpts) ([]string, error)
• func WatchSignals() os.Signal
• type CommandOpts
• type PipelineCommandOpts

Functions

func NotifySignals

func NotifySignals(c chan os.Signal)

func PipelineCommand

func PipelineCommand(opts PipelineCommandOpts) ([]string, error)

func StepCommand

func StepCommand(opts CommandOpts) ([]string, error)

StepCommand returns the command string for running a single step. The path argument can be omitted, which is particularly helpful if the current directory is a pipeline.

func WatchSignals

func WatchSignals() os.Signal

WatchSignals blocks the current goroutine / thread and waits for any signal and returns an error

Types

type CommandOpts

type CommandOpts struct {
	args.PipelineArgs

	// Step is the pipeline step this command is being generated for. The step contains a lot of necessary information for generating a command, mostly around arguments.
	Step             pipeline.Step
	CompiledPipeline string
}

CommandOpts is a list of arguments that can be provided to the StepCommand function.

type PipelineCommandOpts

type PipelineCommandOpts struct {
	CommandOpts
	Pipeline pipeline.Pipeline
}