report

Documentation

Index

• type Formatter
• type Message
• type Report
  • func New(client *github.Client, beginning time.Time) Report
  • func (r *Report) AttachFormatter(f Formatter)
  • func (r *Report) Run()
  • func (r *Report) SetFilter(filter filter.Filter)

Types

type Formatter

type Formatter interface {
	Format(Message)
	FormatError(error)
	Close()
}

Formatter is a interface for output Formatters to implement

type Message

type Message struct {
	github.Event

	EventName string
	Payload   interface{}
	Message   string
}

Message represents some event from GitHub, but with a little preprocessing

type Report

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

Report will read data from GitHub and forward then to the Formatters

func New

func New(client *github.Client, beginning time.Time) Report

New Report

func (*Report) AttachFormatter

func (r *Report) AttachFormatter(f Formatter)

AttachFormatter to receive the messages

func (*Report) Run

func (r *Report) Run()

func (*Report) SetFilter

func (r *Report) SetFilter(filter filter.Filter)