def

Documentation

Overview

Package def contains definitions / interfaces used across hooks packages.

Index

• type Executor
• type ExecutorCreator
• type Options

Types

type Executor

type Executor interface {
	HasRun() bool
	Run(env map[string]string) error
	Output() string
}

Executor can execute a hook and return the output from hook execution.

type ExecutorCreator

type ExecutorCreator interface {
	CanCreate(hook *config.Hook) bool
	Create(hook *config.Hook) (Executor, error)
}

ExecutorCreator defines a creator that can make executors. Should always call CanCreate first to check if this specific creator can create an executor for hook.

type Options

type Options struct {
	Getter   *getter.Client
	CacheDir string
}

Options sent to New function when making a new Runner.