notify

Documentation

Index

• type Color
• type Message
• type MessageArray
• type Notifier
  • func NewSlackNotifier(webhookURL string) Notifier
• type Notifiers
  • func (n Notifiers) Notify(msg string, opts Options) error
• type Options
• type SlackNotifier
  • func (n *SlackNotifier) Notify(text string, options Options) error

Types

type Color

type Color string

Color is used to represent message color for different states (i.e success, fail)

const (
	// Green for success messages
	Green Color = "good"
	// Yellow for warning messages
	Yellow Color = "warning"
	// Red for error messages
	Red Color = "danger"
)

type Message

type Message struct {
	Text  string `json:"text"`
	Color string `json:"color"`
}

Message builds the attachments content of Message

type MessageArray

type MessageArray struct {
	Attachments []Message `json:"attachments"`
}

MessageArray builds the json message to be posted to webhook

type Notifier

type Notifier interface {
	Notify(string, Options) error
}

Notifier manages notifications

func NewSlackNotifier

func NewSlackNotifier(webhookURL string) Notifier

NewSlackNotifier creates a notifier with web hook url to slack channel. Passing it an empty url makes it a no-op notifier.

type Notifiers

type Notifiers []Notifier

Notifiers is a collection of notification targets

func (Notifiers) Notify

func (n Notifiers) Notify(msg string, opts Options) error

Notify delivers a notification to all targets

type Options

type Options struct {
	Color Color
}

Options is used to configure formatting of notifications

type SlackNotifier

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

SlackNotifier represents slack notifications

func (*SlackNotifier) Notify

func (n *SlackNotifier) Notify(text string, options Options) error

Notify sends the notification