hooks

Documentation

Overview

Package hooks contains a runner that can run hook configured in config file. It uses an abstraction for different executors to make it possible to run different hooks in different executors.

Standard implementation contains an executor for simple commands and scripts. Scripts will use go-getter to download the script and run locally.

Index

• type Runner
  • func New(options *def.Options) *Runner
  • func (r *Runner) Run(file *loader.ParsedFile, event, command string) error
  • func (r *Runner) ShouldRun(hook *config.Hook, event, command string) bool

Types

type Runner

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

Runner that can execute hooks

func New

func New(options *def.Options) *Runner

New creates a new runner for executing hooks.

func (*Runner) Run

func (r *Runner) Run(file *loader.ParsedFile, event, command string) error

Run all hooks in source for a specific event. Command input can filter hooks that should only be run got specific terraform commands.

func (*Runner) ShouldRun

func (r *Runner) ShouldRun(hook *config.Hook, event, command string) bool

ShouldRun checks if the hook should run for event and command sent as input. Returns true if it should continue to process hook, and false otherwise.