notify

Documentation

Overview

Package notify defines interfaces each supported notification destination should implement.

Index

• type Destination
• type DestinationMock
  • func (mock *DestinationMock) Send(ctx context.Context, text string) error
  • func (mock *DestinationMock) SendCalls() []struct{ ... }
  • func (mock *DestinationMock) String() string
  • func (mock *DestinationMock) StringCalls() []struct{}
• type Destinations
  • func (d Destinations) Send(ctx context.Context, text string) error
  • func (d Destinations) String() string
• type Github
  • func NewGithub(params GithubParams) (*Github, error)
  • func (g *Github) Send(ctx context.Context, text string) error
  • func (g *Github) String() string
• type GithubParams
• type Mattermost
  • func NewMattermost(lg *log.Logger, cl http.Client, url string) *Mattermost
  • func (m *Mattermost) Send(ctx context.Context, text string) error
  • func (m *Mattermost) String() string
• type MattermostBot
  • func NewMattermostBot(lg *log.Logger, cl http.Client, baseURL, token, channelID string) (bot *MattermostBot, err error)
  • func (b *MattermostBot) Send(ctx context.Context, text string) error
  • func (b *MattermostBot) String() string
• type Post
  • func (p *Post) Send(ctx context.Context, text string) error
  • func (p *Post) String() string
• type Telegram
  • func NewTelegram(params TelegramParams) *Telegram
  • func (t *Telegram) Send(ctx context.Context, text string) error
  • func (t *Telegram) String() string
• type TelegramParams
• type WriterNotifier
  • func (w *WriterNotifier) Send(_ context.Context, text string) error
  • func (w *WriterNotifier) String() string

Types

type Destination

type Destination interface {
	fmt.Stringer
	// Send the release notes to the destination.
	Send(ctx context.Context, text string) error
}

Destination defines interface for a given destination service, like telegram, email or stdout.

type DestinationMock

type DestinationMock struct {
	// SendFunc mocks the Send method.
	SendFunc func(ctx context.Context, text string) error

	// StringFunc mocks the String method.
	StringFunc func() string
	// contains filtered or unexported fields
}

DestinationMock is a mock implementation of Destination.

func TestSomethingThatUsesDestination(t *testing.T) {

	// make and configure a mocked Destination
	mockedDestination := &DestinationMock{
		SendFunc: func(ctx context.Context, text string) error {
			panic("mock out the Send method")
		},
		StringFunc: func() string {
			panic("mock out the String method")
		},
	}

	// use mockedDestination in code that requires Destination
	// and then make assertions.

}

func (*DestinationMock) Send

func (mock *DestinationMock) Send(ctx context.Context, text string) error

Send calls SendFunc.

func (*DestinationMock) SendCalls

func (mock *DestinationMock) SendCalls() []struct {
	Ctx  context.Context
	Text string
}

SendCalls gets all the calls that were made to Send. Check the length with:

len(mockedDestination.SendCalls())

func (*DestinationMock) String

func (mock *DestinationMock) String() string

String calls StringFunc.

func (*DestinationMock) StringCalls

func (mock *DestinationMock) StringCalls() []struct {
}

StringCalls gets all the calls that were made to String. Check the length with:

len(mockedDestination.StringCalls())

type Destinations

type Destinations []Destination

Destinations is an aggregation of notifiers.

func (Destinations) Send

func (d Destinations) Send(ctx context.Context, text string) error

Send sends the message to all destinations.

func (Destinations) String

func (d Destinations) String() string

String returns the names of all destinations.

type Github

type Github struct {
	GithubParams
	// contains filtered or unexported fields
}

Github makes a new release on Github on the given version.

func NewGithub

func NewGithub(params GithubParams) (*Github, error)

NewGithub makes new instance of Github.

func (*Github) Send

func (g *Github) Send(ctx context.Context, text string) error

Send makes new release on github repository.

func (*Github) String

func (g *Github) String() string

String returns the string representation of the destination.

type GithubParams

type GithubParams struct {
	Evaluator           *eval.Evaluator
	Owner               string
	Name                string
	BasicAuthUsername   string
	BasicAuthPassword   string
	HTTPClient          http.Client
	ReleaseNameTmplText string
	Tag                 string
	Extras              map[string]string
}

GithubParams describes parameters to initialize github releaser.

type Mattermost

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

Mattermost sends messages to Mattermost via webhook.

func NewMattermost

func NewMattermost(lg *log.Logger, cl http.Client, url string) *Mattermost

NewMattermost makes a new Mattermost notifier.

func (*Mattermost) Send

func (m *Mattermost) Send(ctx context.Context, text string) error

Send sends a message to Mattermost.

func (*Mattermost) String

func (m *Mattermost) String() string

String returns the name of the notifier.

type MattermostBot

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

MattermostBot sends messages to Mattermost via webhook.

func NewMattermostBot

func NewMattermostBot(lg *log.Logger, cl http.Client, baseURL, token, channelID string) (bot *MattermostBot, err error)

NewMattermostBot makes a new Mattermost notifier.

func (*MattermostBot) Send

func (b *MattermostBot) Send(ctx context.Context, text string) error

Send sends a message to Mattermost.

func (*MattermostBot) String

func (b *MattermostBot) String() string

String returns the name of the notifier.

type Post

type Post struct {
	Log    *log.Logger
	URL    string
	Client *http.Client
}

Post sends a POST request to the given URL with release notes.

func (*Post) Send

func (p *Post) Send(ctx context.Context, text string) error

Send sends a POST request to the given URL with release notes.

func (*Post) String

func (p *Post) String() string

String returns the string representation of the notifier.

type Telegram

type Telegram struct {
	TelegramParams
}

Telegram implements Destination to send changelogs to specified telegram chats.

func NewTelegram

func NewTelegram(params TelegramParams) *Telegram

NewTelegram makes telegram bot for notifications

func (*Telegram) Send

func (t *Telegram) Send(ctx context.Context, text string) error

Send changelog via Telegram.

func (*Telegram) String

func (t *Telegram) String() string

String returns the string representation to identify this notifier.

type TelegramParams

type TelegramParams struct {
	Log                   *log.Logger
	ChatID                string
	Client                http.Client
	Token                 string
	DisableWebPagePreview bool
}

TelegramParams defines parameters needed to initialize Telegram notifier.

type WriterNotifier

type WriterNotifier struct {
	Writer io.Writer
	Name   string // used for debugging purposes
}

WriterNotifier prints the changelog to the specified writer. Writer might be os.Stdout, in order to use in pipelines and CI/CD.

func (*WriterNotifier) Send

func (w *WriterNotifier) Send(_ context.Context, text string) error

Send writes changelog to writer.

func (*WriterNotifier) String

func (w *WriterNotifier) String() string

String returns the string representation to identify this notifier.