templates

Documentation

Index

• Variables
• func DetermineTemplate(templateVar, templatePath, templateInline, templateName, jobStatus string) (string, error)
• func ForName(name string) string
• func ForStatus(status string) string

Variables

var (
	ErrFileNotExist     = errors.New("the file does not exist")
	ErrFileRead         = errors.New("could not read the file")
	ErrInvalidStatus    = errors.New("the status provided is invalid")
	ErrTemplateEmpty    = errors.New("the environment variable provided is empty")
	ErrTemplateNotExist = errors.New("the template does not exist")
)

Functions

func DetermineTemplate

func DetermineTemplate(templateVar, templatePath, templateInline, templateName, jobStatus string) (string, error)

DetermineTemplate returns the template to use for the notification. The order of precedence is templateVar, templatePath, templateInline, templateName. If none of these are provided the default template for the job status is used.

func ForName

func ForName(name string) string

ForName returns the default template body for the provided name if it exists, or the empty string if there is no default.

func ForStatus

func ForStatus(status string) string

ForStatus returns the default template body for the provided status if it exists, or the empty string if there is no default.