notify

Documentation

Index

• type Context
• type Email
  • func (e *Email) Send(context *Context) error
• type Flowdock
  • func (f *Flowdock) Send(context *Context) error
• type Hipchat
  • func (h *Hipchat) Send(context *Context) error
• type IRC
  • func (i *IRC) Connect()
  • func (i *IRC) Send(context *Context) error
• type Notification
  • func (n *Notification) Send(context *Context) error
• type Sender
• type Slack
  • func (s *Slack) Send(context *Context) error
• 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 Flowdock

type Flowdock struct {
	Token   string `yaml:"token,omitempty"`
	Source  string `yaml:"source,omitempty"`
	Tags    string `yaml:"tags,omitempty"`
	Started bool   `yaml:"on_started,omitempty"`
	Success bool   `yaml:"on_success,omitempty"`
	Failure bool   `yaml:"on_failure,omitempty"`
}

func (*Flowdock) Send

func (f *Flowdock) Send(context *Context) error

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 IRC

type IRC struct {
	Channel       string `yaml:"channel,omitempty"`
	Nick          string `yaml:"nick,omitempty"`
	Server        string `yaml:"server,omitempty"`
	Started       bool   `yaml:"on_started,omitempty"`
	Success       bool   `yaml:"on_success,omitempty"`
	Failure       bool   `yaml:"on_failure,omitempty"`
	SSL           bool   `yaml:"ssl,omitempty"`
	ClientStarted bool
	Client        *irc.Conn
}

func (*IRC) Connect

func (i *IRC) Connect()

func (*IRC) Send

func (i *IRC) Send(context *Context) error

type Notification

type Notification struct {
	Email    *Email    `yaml:"email,omitempty"`
	Webhook  *Webhook  `yaml:"webhook,omitempty"`
	Hipchat  *Hipchat  `yaml:"hipchat,omitempty"`
	Irc      *IRC      `yaml:"irc,omitempty"`
	Slack    *Slack    `yaml:"slack,omitempty"`
	Flowdock *Flowdock `yaml:"flowdock,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 Slack

type Slack struct {
	Team     string `yaml:"team,omitempty"`
	Channel  string `yaml:"channel,omitempty"`
	Username string `yaml:"username,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 (*Slack) Send

func (s *Slack) 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