notification

Documentation

Index

• type File
  • func (f *File) AllGroups(changeType config.ChangeType) []string
  • func (f *File) AllUsers(changeType config.ChangeType) []string
  • func (f *File) Channel(changeType config.ChangeType) string
  • func (f *File) Groups(changeType config.ChangeType) []string
  • func (f *File) ProcessTemplate(changeType config.ChangeType) (string, error)
  • func (f *File) String() string
  • func (f *File) Users(changeType config.ChangeType) []string
• type Loader
  • func NewLoader(ghClient *ghclient.GhClient) *Loader
  • func (n *Loader) LoadForPath(ctx context.Context, path string) (*File, error)
• type Merger
  • func NewMerger(notificationLoader *Loader) *Merger
  • func (n *Merger) Merge(ctx context.Context, path string) (*File, error)
• type Notification

Types

type File

type File struct {
	PullRequest     Notification `yaml:"pullRequest,omitempty"`
	Commit          Notification `yaml:"commit,omitempty"`
	PrettyName      []string     `yaml:"prettyName,omitempty"`
	MessageTemplate string       `yaml:"messageTemplate,omitempty"`
	// Parent is the notification file in the Parent directory. If there is none, it's an empty file.
	Parent      *File  `yaml:"-"` // This is used to allow us to merge the Parent with the child
	ChangedFile string `yaml:"-"` // Which files were changed that caused this notification file to be used
}

func (*File) AllGroups

func (f *File) AllGroups(changeType config.ChangeType) []string

func (*File) AllUsers

func (f *File) AllUsers(changeType config.ChangeType) []string

func (*File) Channel

func (f *File) Channel(changeType config.ChangeType) string

func (*File) Groups

func (f *File) Groups(changeType config.ChangeType) []string

func (*File) ProcessTemplate

func (f *File) ProcessTemplate(changeType config.ChangeType) (string, error)

func (*File) String

func (f *File) String() string

func (*File) Users

func (f *File) Users(changeType config.ChangeType) []string

type Loader

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

func NewLoader

func NewLoader(ghClient *ghclient.GhClient) *Loader

func (*Loader) LoadForPath

func (n *Loader) LoadForPath(ctx context.Context, path string) (*File, error)

type Merger

type Merger struct {
	NotificationLoader *Loader
}

func NewMerger

func NewMerger(notificationLoader *Loader) *Merger

func (*Merger) Merge

func (n *Merger) Merge(ctx context.Context, path string) (*File, error)

type Notification

type Notification struct {
	// Which Slack channel to notify on a change
	Channel string `yaml:"channel,omitempty"`
	// Which users to tag in the notification
	Users           []string `yaml:"users,omitempty"`
	Groups          []string `yaml:"groups,omitempty"`
	MessageTemplate string   `yaml:"messageTemplate,omitempty"`
}