buildkitereporter

Documentation

Overview

This package provides buildkite annotations of failed tasks per buildkite job. It is primarily meant to be run directly in CI. Docs: https://buildkite.com/docs/agent/v3/cli-annotate

Index

• func Option(opts ...ReporterOption) func(*taskrunner.Runtime)
• func WithUpload(r *reporter)
• func WithWarningUpload(r *reporter)
• type ReporterOption
  • func WithMaxLines(maxLines int) ReporterOption
  • func WithPath(path string) ReporterOption
  • func WithStreams(streams ...taskrunner.TaskLogEventStream) ReporterOption

Functions

func Option

func Option(opts ...ReporterOption) func(*taskrunner.Runtime)

func WithUpload

func WithUpload(r *reporter)

WithUpload is mutually exclusive vs WithPath. Uploads the buildkite annotation directly.

func WithWarningUpload

func WithWarningUpload(r *reporter)

WithWarningUpload is mutually exclusive vs WithPath. Uploads the buildkite annotation directly as a warning. This contrasts with WithUpload which will upload as an error.

Types

type ReporterOption

type ReporterOption func(r *reporter)

func WithMaxLines

func WithMaxLines(maxLines int) ReporterOption

WithMaxLines sets the maximum stderr lines per task in the annotation (default: 50).

func WithPath

func WithPath(path string) ReporterOption

WithPath sets a save path for the buildkite annotation (default: "taskrunner.annotation.md").

func WithStreams

func WithStreams(streams ...taskrunner.TaskLogEventStream) ReporterOption

WithStreams sets which log streams to listen to (default: stderr).