check

Documentation

Index

• type Builder
  • func NewBuilder(name, headSHA string) *Builder
  • func (b *Builder) CheckRunCreate() *github.CreateCheckRunOptions
  • func (b *Builder) CheckRunUpdate() *github.UpdateCheckRunOptions
  • func (b *Builder) Writef(format string, args ...any)
• type Conclusion
• type Status

Types

type Builder

type Builder struct {
	Summary    string
	Status     Status
	Conclusion Conclusion
	// contains filtered or unexported fields
}

func NewBuilder

func NewBuilder(name, headSHA string) *Builder

func (*Builder) CheckRunCreate

func (b *Builder) CheckRunCreate() *github.CreateCheckRunOptions

CheckRun returns a GitHub CheckRun object with the current state of the Builder.

If the Summary field is empty, it will be set to the name field. If the Conclusion field is set, the CheckRun will be marked as completed.

func (*Builder) CheckRunUpdate

func (b *Builder) CheckRunUpdate() *github.UpdateCheckRunOptions

func (*Builder) Writef

func (b *Builder) Writef(format string, args ...any)

Writef appends a formatted string to the CheckRun output.

If the output exceeds the maximum length, it will be truncated and a message will be appended.

type Conclusion

type Conclusion string

const (
	ConclusionActionRequired Conclusion = "action_required"
	ConclusionCancelled      Conclusion = "cancelled"
	ConclusionFailure        Conclusion = "failure"
	// ConclusionNeutral is the default, and is sufficient to pass a required check.
	ConclusionNeutral  Conclusion = "neutral"
	ConclusionSuccess  Conclusion = "success"
	ConclusionTimedOut Conclusion = "timed_out"
	// ConclusionSkipped is not sufficient to pass a required check.
	ConclusionSkipped Conclusion = "skipped"
)

type Status

type Status string

const (
	StatusQueued     Status = "queued"
	StatusInProgress Status = "in_progress"
	StatusCompleted  Status = "completed"
	StatusWaiting    Status = "waiting"
	StatusRequested  Status = "requested"
	StatusPending    Status = "pending"
)