circleci

Documentation

Index

• Constants
• func ExampleMessage(cfg config.Configuration, data util.ExampleData) (cc.Message, error)
• func NewHandler() handlers.Handler
• func Normalize(cfg config.Configuration, hReq handlers.HandlerRequest) (cc.Message, error)
• type CircleciOutAction
• type CircleciOutMessage
  • func CircleciOutMessageFromBytes(bytes []byte) (CircleciOutMessage, error)
• type CircleciOutPayload
• type CircleciOutStep

Constants

const (
	DisplayName      = "Circlecl"
	HandlerKey       = "circleci"
	MessageDirection = "out"
	DocumentationURL = "https://circleci.com/docs/1.0/configuration/#notify"
	MessageBodyType  = models.JSON
)

Functions

func ExampleMessage

func ExampleMessage(cfg config.Configuration, data util.ExampleData) (cc.Message, error)

func NewHandler

func NewHandler() handlers.Handler

func Normalize

func Normalize(cfg config.Configuration, hReq handlers.HandlerRequest) (cc.Message, error)

Types

type CircleciOutAction

type CircleciOutAction struct {
	BashCommand   any    `json:"bash_command,omitempty"`
	RunTimeMillis int64  `json:"run_time_millis,omitempty"`
	StartTime     string `json:"start_time,omitempty"`
	EndTime       string `json:"end_time,omitempty"`
	Name          string `json:"name,omitempty"`
	ExitCode      any    `json:"exit_cide,omitempty"`
	Type          string `json:"type,omitempty"`
	Index         int64  `json:"index,omitempty"`
	Status        string `json:"status,omitempty"`
}

type CircleciOutMessage

type CircleciOutMessage struct {
	VCSURL          string `json:"vcs_url,omitempty"`
	BuildURL        string `json:"build_url,omitempty"`
	BuildNum        int64  `json:"build_num,omitempty"`
	Branch          string `json:"branch,omitempty"`
	VCSRevision     string `json:"vcs_revision,omitempty"`
	CommitterName   string `json:"committer_name,omitempty"`
	CommitterEmail  string `json:"committer_email,omitempty"`
	Subject         string `json:"subject,omitempty"`
	Body            string `json:"body,omitempty"`
	Why             string `json:"why,omitempty"`
	DontBuild       any    `json:"dont_build,omitempty"`
	QueuedAt        string `json:"queued_at,omitempty"`
	StartTime       string `json:"start_time,omitempty"`
	StopTime        string `json:"stop_time,omitempty"`
	BuildTimeMillis int64  `json:"build_time_millis,omitempty"`
	Username        string `json:"username,omitempty"`
	Reponame        string `json:"reponame,omitempty"`
	Lifecycle       string `json:"lifecycle,omitempty"`
	Outcome         string `json:"outcome,omitempty"`
	Status          string `json:"status,omitempty"`
	RetryOf         any    `json:"retry_of,omitempty"`
	Steps           []any  `json:"steps,omitempty"`
}

func CircleciOutMessageFromBytes

func CircleciOutMessageFromBytes(bytes []byte) (CircleciOutMessage, error)

type CircleciOutPayload

type CircleciOutPayload struct {
	Payload CircleciOutMessage `json:"payload,omitempty"`
}

type CircleciOutStep

type CircleciOutStep struct {
	Name    string              `json:"name,omitempty"`
	Actions []CircleciOutAction `json:"actions,omitempty"`
}