reports

Documentation

Index

• func RegisterReport(report Report) error
• func RegisterReportOrDie(report Report)
• func RunReports(cfg *github.Config, runReports ...string) error
• type Report
  • func GetActiveReports() []Report
  • func GetAllReports() []Report
• type ShameReport
  • func (s *ShameReport) AddFlags(cmd *cobra.Command, config *githubhelper.Config)
  • func (s *ShameReport) Name() string
  • func (s *ShameReport) Report(cfg *githubhelper.Config) error

Functions

func RegisterReport

func RegisterReport(report Report) error

RegisterReport should be called in `init()` by each report to make itself available by name

func RegisterReportOrDie

func RegisterReportOrDie(report Report)

RegisterReportOrDie will call RegisterReport but will be fatal on error

func RunReports

func RunReports(cfg *github.Config, runReports ...string) error

RunReports runs the specified reports.

Types

type Report

type Report interface {
	// Take action on a specific github issue:
	Report(config *github.Config) error
	AddFlags(cmd *cobra.Command, config *github.Config)
	Name() string
}

Report is the interface which all reports must implement to register

func GetActiveReports

func GetActiveReports() []Report

GetActiveReports returns a slice of all reports which both registered and were requested by the user

func GetAllReports

func GetAllReports() []Report

GetAllReports returns a slice of all registered reports. This list is completely independant of the reports selected at runtime in --pr-reports. This is all possible reports.

type ShameReport

type ShameReport struct {
	Command             string
	From                string
	Cc                  string
	ReplyTo             string
	AllowedShameDomains string
}

ShameReport lists flaky tests and writes group+individual email to nag people to fix them.

func (*ShameReport) AddFlags

func (s *ShameReport) AddFlags(cmd *cobra.Command, config *githubhelper.Config)

AddFlags will add any request flags to the cobra `cmd`

func (*ShameReport) Name

func (s *ShameReport) Name() string

Name is the name usable in --issue-reports

func (*ShameReport) Report

func (s *ShameReport) Report(cfg *githubhelper.Config) error

Report is the workhorse that actually makes the report.