hooks

Documentation

Index

• func Defined() bool
• func Parse()
• func Runner(path, filename string, ctx speccontext.GitContext, partsCtx parts.Context) error
• type AWSLambdaHook
  • func (l *AWSLambdaHook) Run(path string) error
• type Config
• type Hook
  • func (h *Hook) CanRun(path string, ctx speccontext.GitContext, partsCtx parts.Context) (matched bool)
  • func (h *Hook) Definition() Spec
• type HttpHook
  • func (l *HttpHook) Run(path string) error
• type LocalHook
  • func (l *LocalHook) Run(path string) error
• type NoopHook
  • func (n NoopHook) Run(_ string) error
• type Spec

Functions

func Defined

func Defined() bool

func Parse

func Parse()

func Runner

func Runner(path, filename string, ctx speccontext.GitContext, partsCtx parts.Context) error

Types

type AWSLambdaHook

type AWSLambdaHook struct {
	AssumeRole     string `mapstructure:"assume_role"`
	FunctionName   string `mapstructure:"function_name"`
	InvocationType string `mapstructure:"invocation_type"` // RequestResponse, Event, DryRun
	Region         string
	Payload        string
}

func (*AWSLambdaHook) Run

func (l *AWSLambdaHook) Run(path string) error

type Config

type Config struct {
	Hooks []Hook
}

type Hook

type Hook struct {
	Type         string
	PathFilter   string            `mapstructure:"path_filter"`
	MatchContext map[string]string `mapstructure:"match_context"`
	RequireEnv   []string          `mapstructure:"require_env"`
	Spec         interface{}
}

func (*Hook) CanRun

func (h *Hook) CanRun(path string, ctx speccontext.GitContext, partsCtx parts.Context) (matched bool)

CanRun ensures the hook can be executed. It checks that the path matches what specified in path_filter checks that match_context rules are satisfied. If the match defined with "/" as prefix and suffix it matches it as a regexp. To execute hook for a part upload you have to specify the match_context["part"] require_env matches can be a full line, specified like: "CI=true" or only with a name of the variable "CI"

func (*Hook) Definition

func (h *Hook) Definition() Spec

type HttpHook

type HttpHook struct {
	Method  string
	Url     string
	Body    string
	Headers map[string]string
}

func (*HttpHook) Run

func (l *HttpHook) Run(path string) error

type LocalHook

type LocalHook struct {
	Command string
}

func (*LocalHook) Run

func (l *LocalHook) Run(path string) error

type NoopHook

type NoopHook struct{}

func (NoopHook) Run

func (n NoopHook) Run(_ string) error

type Spec

type Spec interface {
	Run(path string) error
}