reports

Documentation

Index

• func RegisterOptions(opts *options.Options) sets.String
• 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

Functions

func RegisterOptions

func RegisterOptions(opts *options.Options) sets.String

RegisterOptions registers options used by reports and returns any options that should trigger a restart if they are changed.

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
	RegisterOptions(opts *options.Options) sets.String
	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 independent of the reports selected at runtime in --pr-reports. This is all possible reports.