report

Documentation

Overview

Package report contains helpers for writing comments and updating statuses in Github.

Index

• func Report(ghc GithubClient, reportTemplate *template.Template, pj kube.ProwJob) error
• type GithubClient

Functions

func Report

func Report(ghc GithubClient, reportTemplate *template.Template, pj kube.ProwJob) error

Report is creating/updating/removing reports in Github based on the state of the provided ProwJob.

Types

type GithubClient

type GithubClient interface {
	BotName() (string, error)
	CreateStatus(org, repo, ref string, s github.Status) error
	ListIssueComments(org, repo string, number int) ([]github.IssueComment, error)
	CreateComment(org, repo string, number int, comment string) error
	DeleteComment(org, repo string, ID int) error
	EditComment(org, repo string, ID int, comment string) error
}

GithubClient provides a client interface to report job status updates through Github comments.