github

Documentation

Overview

Package reporter implements a reporter interface for github TODO(krzyzacy): move logic from report.go here

Index

• Constants
• type Client
  • func NewReporter(gc report.GitHubClient, cfg config.Getter, reportAgent v1.ProwJobAgent, ...) *Client
  • func (c *Client) GetName() string
  • func (c *Client) Report(ctx context.Context, log *logrus.Entry, pj *v1.ProwJob) ([]*v1.ProwJob, *reconcile.Result, error)
  • func (c *Client) ShouldReport(_ context.Context, _ *logrus.Entry, pj *v1.ProwJob) bool

Constants

const (
	// GitHubReporterName is the name for github reporter
	GitHubReporterName = "github-reporter"
)

Types

type Client

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

Client is a github reporter client

func NewReporter

func NewReporter(gc report.GitHubClient, cfg config.Getter, reportAgent v1.ProwJobAgent, lister ctrlruntimeclient.Reader) *Client

NewReporter returns a reporter client

func (*Client) GetName

func (c *Client) GetName() string

GetName returns the name of the reporter

func (*Client) Report

func (c *Client) Report(ctx context.Context, log *logrus.Entry, pj *v1.ProwJob) ([]*v1.ProwJob, *reconcile.Result, error)

Report will report via reportlib

func (*Client) ShouldReport

func (c *Client) ShouldReport(_ context.Context, _ *logrus.Entry, pj *v1.ProwJob) bool

ShouldReport returns if this prowjob should be reported by the github reporter