shell

Documentation

Index

• func NewShellPlugin(scope *scope.Scope, params manifest.RawParams, log log.Logger) (plugins.Plugin, error)
• type Params
• type Plugin
  • func (p *Plugin) Call(tx *job.RunContext, r plugins.JobRunner) (err error)
  • func (p *Plugin) Cancel(ctx *job.RunContext) error

Functions

func NewShellPlugin

func NewShellPlugin(scope *scope.Scope, params manifest.RawParams, log log.Logger) (plugins.Plugin, error)

NewShellPlugin creates a new shell plugin instance

Types

type Params

type Params struct {
	// Command is command to execute
	Command string

	// Silent param hides stdout and stderr from output
	Silent bool

	// RawOutput removes logging output decoration from stdout and stderr
	RawOutput bool

	// Shell is default shell to start
	Shell string

	// ShellExecParam is param used by shell to pass command.
	//
	// Example: "bash -c "your command"
	ShellExecParam string

	// WorkDir is current working directory
	WorkDir string

	// Env is set of environment variables
	Env shell.Environment
}

Params contains params for shell plugin

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

Plugin represents Gilbert's plugin

func (*Plugin) Call

func (p *Plugin) Call(tx *job.RunContext, r plugins.JobRunner) (err error)

Call calls a plugin

func (*Plugin) Cancel

func (p *Plugin) Cancel(ctx *job.RunContext) error

Cancel cancels shell command execution