github

Documentation

Index

• Constants
• func NewClient(ctx context.Context, token string) *github.Client
• type CheckCreator
• type CheckRun
  • func NewCheckRun(cc CheckCreator, owner, repo, headSHA, checkName string) *CheckRun
  • func (c *CheckRun) Notify(ctx context.Context, body string) error
• type StepSummary
  • func NewStepSummary() *StepSummary
  • func (*StepSummary) Notify(_ context.Context, body string) error

Constants

const DefaultCheckName = "Coverage report"

Functions

func NewClient

func NewClient(ctx context.Context, token string) *github.Client

Types

type CheckCreator

type CheckCreator interface {
	CreateCheckRun(ctx context.Context, owner, repo string, opts github.CreateCheckRunOptions) (*github.CheckRun, *github.Response, error)
}

CheckCreator is just an interface to allow easy testing

type CheckRun

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

CheckRun implements coverage report notification for github check runs.

func NewCheckRun

func NewCheckRun(cc CheckCreator, owner, repo, headSHA, checkName string) *CheckRun

func (*CheckRun) Notify

func (c *CheckRun) Notify(ctx context.Context, body string) error

Notify creates a check run into github pull request with the given coverage report.

type StepSummary

type StepSummary struct{}

StepSummary implements coverage report notification for github actions step summary.

func NewStepSummary

func NewStepSummary() *StepSummary

func (*StepSummary) Notify

func (*StepSummary) Notify(_ context.Context, body string) error

Notify creates a check run into github pull request with the given coverage report.