crier

Documentation

Overview

Package crier reports finished prowjob status to git providers.

Package crier reports finished prowjob status to git providers.

Index

• Constants
• func New(mgr manager.Manager, reporter ReportClient, numWorkers int, ...) error
• type ReportClient

Constants

const (
	ResultError   = "ERROR"
	ResultSuccess = "SUCCESS"
)

Functions

func New

func New(
	mgr manager.Manager,
	reporter ReportClient,
	numWorkers int,
	enablementChecker func(org, repo string) bool,
) error

New constructs a new instance of the crier reconciler.

Types

type ReportClient

type ReportClient interface {
	// Report reports a Prowjob. The provided logger is already populated with the
	// prowjob name and the reporter name.
	// If a reporter wants to defer reporting, it can return a reconcile.Result with a RequeueAfter
	Report(ctx context.Context, log *logrus.Entry, pj *prowv1.ProwJob) ([]*prowv1.ProwJob, *reconcile.Result, error)
	GetName() string
	// ShouldReport determines if a ProwJob should be reported. The provided logger
	// is already populated with the prowjob name and the reporter name.
	ShouldReport(ctx context.Context, log *logrus.Entry, pj *prowv1.ProwJob) bool
}