github

Documentation

Index

• Constants
• func New(opts ...NewOption) internal.Reporter
• func NewGithubClient(baseURL, token string) github.Github
• type NewOption
  • func WithGithubClient(github github.Github) NewOption
  • func WithGithubToken(token string) NewOption
  • func WithGithubURL(url string) NewOption

Constants

const (
	ReporterName = "github"

	LabelNameLogs    = "Samsahai Deployment - Logs"
	LabelNameHistory = "Samsahai Deployment - History"
)

Functions

func New

func New(opts ...NewOption) internal.Reporter

New creates a new Github reporter

func NewGithubClient

func NewGithubClient(baseURL, token string) github.Github

NewGithubClient returns a github client for publishing commit status to github

Types

type NewOption

type NewOption func(*reporter)

NewOption allows specifying various configuration

func WithGithubClient

func WithGithubClient(github github.Github) NewOption

WithGithubClient specifies a github client to override when creating Github reporter

func WithGithubToken

func WithGithubToken(token string) NewOption

WithGithubToken specifies a github access token to override when creating Github reporter

func WithGithubURL

func WithGithubURL(url string) NewOption

WithGithubURL specifies a github url to override when creating Github reporter