reporter

Documentation

Overview

Package reporter provides check result reporting.

Index

• type GitHub
  • func NewGitHubReporter() (*GitHub, error)
  • func (gh *GitHub) SetStatus(state, policy, check, message string) error
• type Noop
  • func (n *Noop) SetStatus(_, _, _, _ string) error
• type Reporter

Types

type GitHub

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

GitHub is a reporter that summarizes policy statuses as GitHub statuses.

func NewGitHubReporter

func NewGitHubReporter() (*GitHub, error)

NewGitHubReporter returns a reporter that posts policy checks as status checks on a pull request.

func (*GitHub) SetStatus

func (gh *GitHub) SetStatus(state, policy, check, message string) error

SetStatus sets the status of a GitHub check.

Valid statuses are "error", "failure", "pending", "success".

type Noop

type Noop struct{}

Noop is a reporter that does nothing.

func (*Noop) SetStatus

func (n *Noop) SetStatus(_, _, _, _ string) error

SetStatus is a noop func.

type Reporter

type Reporter interface {
	SetStatus(string, string, string, string) error
}

Reporter describes a hook for sending summarized results to a remote API.