notify

Documentation

Index

• type Context
• type Email
  • func (e *Email) Send(context *Context) error
• type Hipchat
  • func (h *Hipchat) Send(context *Context) error
• type Notification
  • func (n *Notification) Send(context *Context) error
• type Sender
• type Webhook
  • func (w *Webhook) Send(context *Context) error

Types

type Context

type Context struct {
	// Global settings
	Host string

	// User that owns the repository
	User *model.User

	// Repository being built.
	Repo *model.Repo

	// Commit being built
	Commit *model.Commit
}

Context represents the context of an in-progress build request.

type Email

type Email struct {
	Recipients []string `yaml:"recipients,omitempty"`
	Success    string   `yaml:"on_success"`
	Failure    string   `yaml:"on_failure"`
}

func (*Email) Send

func (e *Email) Send(context *Context) error

Send will send an email, either success or failure, based on the Commit Status.

type Hipchat

type Hipchat struct {
	Room    string `yaml:"room,omitempty"`
	Token   string `yaml:"token,omitempty"`
	Started bool   `yaml:"on_started,omitempty"`
	Success bool   `yaml:"on_success,omitempty"`
	Failure bool   `yaml:"on_failure,omitempty"`
}

func (*Hipchat) Send

func (h *Hipchat) Send(context *Context) error

type Notification

type Notification struct {
	Email   *Email   `yaml:"email,omitempty"`
	Webhook *Webhook `yaml:"webhook,omitempty"`
	Hipchat *Hipchat `yaml:"hipchat,omitempty"`
}

Notification stores the configuration details for notifying a user, or group of users, when their Build has completed.

func (*Notification) Send

func (n *Notification) Send(context *Context) error

type Sender

type Sender interface {
	Send(context *Context) error
}

type Webhook

type Webhook struct {
	URL     []string `yaml:"urls,omitempty"`
	Success bool     `yaml:"on_success,omitempty"`
	Failure bool     `yaml:"on_failure,omitempty"`
}

func (*Webhook) Send

func (w *Webhook) Send(context *Context) error