commitstatus package - code.gitea.io/gitea/modules/commitstatus

Documentation ¶

Index ¶

type CommitStatusState
type CommitStatusStates
- func (css CommitStatusStates) Combine() CommitStatusState

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type CommitStatusState ¶

type CommitStatusState string //nolint:revive // export stutter

CommitStatusState holds the state of a CommitStatus swagger:enum CommitStatusState

const (
	// CommitStatusPending is for when the CommitStatus is Pending
	CommitStatusPending CommitStatusState = "pending"
	// CommitStatusSuccess is for when the CommitStatus is Success
	CommitStatusSuccess CommitStatusState = "success"
	// CommitStatusError is for when the CommitStatus is Error
	CommitStatusError CommitStatusState = "error"
	// CommitStatusFailure is for when the CommitStatus is Failure
	CommitStatusFailure CommitStatusState = "failure"
	// CommitStatusWarning is for when the CommitStatus is Warning
	CommitStatusWarning CommitStatusState = "warning"
	// CommitStatusSkipped is for when CommitStatus is Skipped
	CommitStatusSkipped CommitStatusState = "skipped"
)

func (CommitStatusState) IsError ¶

func (css CommitStatusState) IsError() bool

IsError represents if commit status state is error

func (CommitStatusState) IsFailure ¶

func (css CommitStatusState) IsFailure() bool

IsFailure represents if commit status state is failure

func (CommitStatusState) IsPending ¶

func (css CommitStatusState) IsPending() bool

IsPending represents if commit status state is pending

func (CommitStatusState) IsSkipped ¶

func (css CommitStatusState) IsSkipped() bool

IsSkipped represents if commit status state is skipped

func (CommitStatusState) IsSuccess ¶

func (css CommitStatusState) IsSuccess() bool

IsSuccess represents if commit status state is success

func (CommitStatusState) IsWarning ¶

func (css CommitStatusState) IsWarning() bool

IsWarning represents if commit status state is warning

func (CommitStatusState) String ¶

func (css CommitStatusState) String() string

type CommitStatusStates ¶

type CommitStatusStates []CommitStatusState //nolint:revive // export stutter

func (CommitStatusStates) Combine ¶

func (css CommitStatusStates) Combine() CommitStatusState

According to https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28#get-the-combined-status-for-a-specific-reference > Additionally, a combined state is returned. The state is one of: > failure if any of the contexts report as error or failure > pending if there are no statuses or a context is pending > success if the latest status for all contexts is success

Source Files ¶

View all Source files

commit_status.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL