hooks

Documentation

Index

• type Command
• type Hook
• type HookEvent
• type Hooks
  • func GetHooks(atmosConfig *schema.AtmosConfiguration, info *schema.ConfigAndStacksInfo) (*Hooks, error)
  • func (h Hooks) ConvertToHooks(input map[string]any) (Hooks, error)
  • func (h Hooks) HasHooks() bool
  • func (h Hooks) RunAll(event HookEvent, atmosConfig *schema.AtmosConfiguration, ...) error
• type StoreCommand
  • func NewStoreCommand(atmosConfig *schema.AtmosConfiguration, info *schema.ConfigAndStacksInfo) (*StoreCommand, error)
  • func (c *StoreCommand) GetName() string
  • func (c *StoreCommand) RunE(hook *Hook, event HookEvent, cmd *cobra.Command, args []string) error

Types

type Command

type Command interface {
	GetName() string
	RunE(hook *Hook, event HookEvent, cmd *cobra.Command, args []string) error
}

Command is the interface for all commands that can be run by hooks

type Hook

type Hook struct {
	Events  []string `yaml:"events"`
	Command string   `yaml:"command"`

	// store command
	Name    string            `yaml:"name,omitempty"`    // for store command
	Outputs map[string]string `yaml:"outputs,omitempty"` // for store command
}

Hook is the structure for a hook and is using in the stack config to define a command that should be run when a specific event occurs.

type HookEvent

type HookEvent string

const (
	AfterTerraformApply  HookEvent = "after.terraform.apply"
	BeforeTerraformApply HookEvent = "before.terraform.apply"
	AfterTerraformPlan   HookEvent = "after.terraform.plan"
	BeforeTerraformPlan  HookEvent = "before.terraform.plan"
)

type Hooks

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

func GetHooks

func GetHooks(atmosConfig *schema.AtmosConfiguration, info *schema.ConfigAndStacksInfo) (*Hooks, error)

func (Hooks) ConvertToHooks

func (h Hooks) ConvertToHooks(input map[string]any) (Hooks, error)

func (Hooks) HasHooks

func (h Hooks) HasHooks() bool

func (Hooks) RunAll

func (h Hooks) RunAll(event HookEvent, atmosConfig *schema.AtmosConfiguration, info *schema.ConfigAndStacksInfo, cmd *cobra.Command, args []string) error

type StoreCommand

type StoreCommand struct {
	Name string
	// contains filtered or unexported fields
}

func NewStoreCommand

func NewStoreCommand(atmosConfig *schema.AtmosConfiguration, info *schema.ConfigAndStacksInfo) (*StoreCommand, error)

func (*StoreCommand) GetName

func (c *StoreCommand) GetName() string

func (*StoreCommand) RunE

func (c *StoreCommand) RunE(hook *Hook, event HookEvent, cmd *cobra.Command, args []string) error

RunE is the entrypoint for the store command