pkg

Documentation

Index

• Variables
• func Pointer[T interface{}](item T) *T
• type AppResults
  • func (ar *AppResults) AddCheckResult(result CheckResult)
• type CheckResult
• type CommitState
  • func WorstState(l1, l2 CommitState) CommitState
  • func (s CommitState) BareString() string
  • func (s CommitState) Emoji() string
  • func (s CommitState) String() string
• type Message
  • func NewMessage(name string, prId, commentId int) *Message
  • func (m *Message) AddNewApp(ctx context.Context, app string)
  • func (m *Message) AddToAppMessage(ctx context.Context, app string, result CheckResult)
  • func (m *Message) BuildComment(ctx context.Context) string
  • func (m *Message) IsSuccess() bool
  • func (m *Message) SetFooter(start time.Time, commitSha string)

Variables

var (
	GitTag    = ""
	GitCommit = ""
)

Functions

func Pointer

func Pointer[T interface{}](item T) *T

Types

type AppResults

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

func (*AppResults) AddCheckResult

func (ar *AppResults) AddCheckResult(result CheckResult)

type CheckResult

type CheckResult struct {
	State            CommitState
	Summary, Details string
}

type CommitState

type CommitState uint8

CommitState is an enum for represnting the state of a commit for posting via CommitStatus

const (
	StateNone CommitState = iota
	StateSuccess
	StateRunning
	StateWarning
	StateFailure
	StateError
	StatePanic
)

func WorstState

func WorstState(l1, l2 CommitState) CommitState

func (CommitState) BareString

func (s CommitState) BareString() string

func (CommitState) Emoji

func (s CommitState) Emoji() string

Emoji returns a string representation of this state for use in the request

func (CommitState) String

func (s CommitState) String() string

type Message

type Message struct {
	Name    string
	Owner   string
	CheckID int
	NoteID  int
	// contains filtered or unexported fields
}

Message type that allows concurrent updates Has a reference to the owner/repo (ie zapier/kubechecks), the PR/MR id, and the actual messsage

func NewMessage

func NewMessage(name string, prId, commentId int) *Message

func (*Message) AddNewApp

func (m *Message) AddNewApp(ctx context.Context, app string)

func (*Message) AddToAppMessage

func (m *Message) AddToAppMessage(ctx context.Context, app string, result CheckResult)

func (*Message) BuildComment

func (m *Message) BuildComment(ctx context.Context) string

func (*Message) IsSuccess

func (m *Message) IsSuccess() bool

func (*Message) SetFooter

func (m *Message) SetFooter(start time.Time, commitSha string)