reporter

Documentation

Overview

Package reporter contains helpers for publishing statues to Pub statuses in Github.

Index

• Constants
• type Client
  • func NewReporter() *Client
  • func (c *Client) GetName() string
  • func (c *Client) Report(pj *kube.ProwJob) error
  • func (c *Client) ShouldReport(pj *kube.ProwJob) bool
• type ReportMessage

Constants

const (
	// PubSubProjectLabel annotation
	PubSubProjectLabel = "prow.k8s.io/pubsub.project"
	// PubSubTopicLabel annotation
	PubSubTopicLabel = "prow.k8s.io/pubsub.topic"
	// PubSubRunIDLabel annotation
	PubSubRunIDLabel = "prow.k8s.io/pubsub.runID"
)

Types

type Client

type Client struct {
}

Client is a reporter client fed to crier controller

func NewReporter

func NewReporter() *Client

NewReporter creates a new Pub/Sub reporter

func (*Client) GetName

func (c *Client) GetName() string

GetName returns the name of the reporter

func (*Client) Report

func (c *Client) Report(pj *kube.ProwJob) error

Report takes a prowjob, and generate a pubsub ReportMessage and publish to specific Pub/Sub topic based on Pub/Sub related labels if they exist in this prowjob

func (*Client) ShouldReport

func (c *Client) ShouldReport(pj *kube.ProwJob) bool

ShouldReport tells if a prowjob should be reported by this reporter

type ReportMessage

type ReportMessage struct {
	Project string            `json:"project"`
	Topic   string            `json:"topic"`
	RunID   string            `json:"runid"`
	Status  kube.ProwJobState `json:"status"`
	URL     string            `json:"url"`
}

ReportMessage is a message structure used to pass a prowjob status to Pub/Sub topic.s