notifications

Documentation

Index

• func BuildWhitelist(regexs ...string) *whitelist
• type Notification
  • func (n Notification) FullName() string
  • func (n Notification) ShortSHA() string
• type Notifier
  • func NewNullNotifier() Notifier
  • func NewSlackNotifier(webhookURL string, clock clock.Clock, whitelist Whitelist, ...) Notifier
• type SlackAttachment
• type SlackMessage
• type SlackNotificationFormatter
  • func NewSlackNotificationFormatter() SlackNotificationFormatter
• type Whitelist

Functions

func BuildWhitelist

func BuildWhitelist(regexs ...string) *whitelist

Types

type Notification

type Notification struct {
	Owner      string
	Repository string
	Private    bool

	Branch string
	SHA    string

	Path       string
	LineNumber int
}

func (Notification) FullName

func (n Notification) FullName() string

func (Notification) ShortSHA

func (n Notification) ShortSHA() string

type Notifier

type Notifier interface {
	SendNotification(lager.Logger, Notification) error
	SendBatchNotification(lager.Logger, []Notification) error
}

func NewNullNotifier

func NewNullNotifier() Notifier

func NewSlackNotifier

func NewSlackNotifier(webhookURL string, clock clock.Clock, whitelist Whitelist, formatter SlackNotificationFormatter) Notifier

type SlackAttachment

type SlackAttachment struct {
	Fallback string `json:"fallback"`
	Color    string `json:"color"`
	Title    string `json:"title"`
	Text     string `json:"text"`
}

type SlackMessage

type SlackMessage struct {
	Attachments []SlackAttachment `json:"attachments"`
}

type SlackNotificationFormatter

type SlackNotificationFormatter interface {
	FormatNotifications(batch []Notification) []SlackMessage
}

func NewSlackNotificationFormatter

func NewSlackNotificationFormatter() SlackNotificationFormatter

type Whitelist

type Whitelist interface {
	ShouldSkipNotification(bool, string) bool
}