exec

Documentation

Overview

Package exec contains the exec plugin.

Index

• func NewCmdAction() pipeline.Action
• type CmdActionInputData
  • func (e *CmdActionInputData) IsActionInput()
• type CmdActionResponse
• type Plugin
  • func (b *Plugin) Config() (interface{}, error)
  • func (b *Plugin) GetActions() []func() pipeline.Action
  • func (b *Plugin) PluginData(_ hclog.Logger) (interface{}, error)
  • func (b *Plugin) ValidateConfig(_ interface{}) error
• type PluginConfig

Functions

func NewCmdAction

func NewCmdAction() pipeline.Action

NewCmdAction returns a new action instance

Types

type CmdActionInputData

type CmdActionInputData struct {
	DotEnvFilename *string `hcl:"dot_env_filename,optional"`
	Command        string  `hcl:"command,attr"`
}

CmdActionInputData is the input data for this action

func (*CmdActionInputData) IsActionInput

func (e *CmdActionInputData) IsActionInput()

IsActionInput is a marker function to indicate that this struct is used for action input

type CmdActionResponse

type CmdActionResponse struct {
	DotEnv   map[string]string
	ExitCode int
}

CmdActionResponse is the response struct returned from the action. These values will be exposed as action outputs so they can be consumed by subsequent actions in the pipeline

type Plugin

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

Plugin is the provider implementation

func (*Plugin) Config

func (b *Plugin) Config() (interface{}, error)

Config returns the config struct for this provider

func (*Plugin) GetActions

func (b *Plugin) GetActions() []func() pipeline.Action

GetActions returns the actions that this provider supports

func (*Plugin) PluginData

func (b *Plugin) PluginData(_ hclog.Logger) (interface{}, error)

PluginData returns data that can be consumed by actions

func (*Plugin) ValidateConfig

func (b *Plugin) ValidateConfig(_ interface{}) error

ValidateConfig validates the config struct for this provider

type PluginConfig

type PluginConfig struct {
}

PluginConfig defines the required config fields for this provider. HCL tags are used for defining the accepted fields https://pkg.go.dev/github.com/hashicorp/hcl/v2/gohcl#pkg-overview