signotify

Documentation

Index

• type Configuration
  • func UnmarshalRead(file string) (Configuration, error)
  • func (c *Configuration) MarshalWrite(file string) error
• type Notify
  • func New(options *Options) (*Notify, error)
  • func (n *Notify) SendNotification(message string) error
• type Options
  • func ParseOptions(options *Options) (*Options, error)
• type Slack

Types

type Configuration

type Configuration struct {
	Version   string `yaml:"version"`
	Platforms struct {
		Slack struct {
			Use        bool   `yaml:"use"`
			WebHookURL string `yaml:"webhook_url"`
		} `yaml:"slack"`
	} `yaml:"platforms"`
}

Configuration is a

func UnmarshalRead

func UnmarshalRead(file string) (Configuration, error)

UnmarshalRead reads the unmarshalled config yaml file from disk

func (*Configuration) MarshalWrite

func (c *Configuration) MarshalWrite(file string) error

MarshalWrite writes the marshaled yaml config to disk

type Notify

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

Notify handles the notification engine

func New

func New(options *Options) (*Notify, error)

New notify instance

func (*Notify) SendNotification

func (n *Notify) SendNotification(message string) error

SendNotification to registered webhooks

type Options

type Options struct {
	ExcludeSources  string
	UseSources      string
	SlackWebHookURL string
	Text            string

	YAMLConfig Configuration
}

Options is the structure of the options expected

func ParseOptions

func ParseOptions(options *Options) (*Options, error)

ParseOptions is a

type Slack

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

Slack is a