Documentation
¶
Index ¶
- Constants
- func BuildFailureMessage(report *FailureReport) *slack.Message
- func BuildSuccessReportMessage(report *DigestReport) *slack.Message
- func FormatMessageForDebug(report *FailureReport) string
- func FormatReportForDebug(report *DigestReport) string
- func NewCliApp() *cli.App
- type DigestReport
- type FailureReport
Constants ¶
View Source
const ( FlagRunID = "run-id" FlagSlackWebhook = "slack-webhook" FlagDryRun = "dry-run" FlagBranch = "branch" FlagDays = "days" FlagWorkflow = "workflow" )
Variables ¶
This section is empty.
Functions ¶
func BuildFailureMessage ¶
func BuildFailureMessage(report *FailureReport) *slack.Message
BuildFailureMessage creates a Slack message for CI failure
func BuildSuccessReportMessage ¶
func BuildSuccessReportMessage(report *DigestReport) *slack.Message
BuildSuccessReportMessage creates a Slack message for success report
func FormatMessageForDebug ¶
func FormatMessageForDebug(report *FailureReport) string
FormatMessageForDebug formats the message for console output
func FormatReportForDebug ¶
func FormatReportForDebug(report *DigestReport) string
FormatReportForDebug formats the success report for console output
Types ¶
type DigestReport ¶
type DigestReport struct {
Branch string
WorkflowName string
StartDate time.Time
EndDate time.Time
TotalRuns int
SuccessfulRuns int
FailedRuns int
SuccessRate float64
AverageDuration time.Duration
MedianDuration time.Duration
Under20MinutesPercent float64
Under25MinutesPercent float64
Under30MinutesPercent float64
Runs []github.Run
}
DigestReport aggregates success metrics for a time period
func BuildDigest ¶
func BuildDigest(branch, workflowName string, days int) (*DigestReport, error)
BuildDigest builds a digest report for the specified time range
type FailureReport ¶
type FailureReport struct {
Run github.Run
FailedJobs []github.Job
Failures []string
TotalJobs int
}
FailureReport aggregates all failure information
func BuildFailureReport ¶
func BuildFailureReport(runID string) (*FailureReport, error)
BuildFailureReport aggregates all failure information
Source Files
Click to show internal directories.
Click to hide internal directories.