annotations

Documentation

Overview

Package annotations provides a basic API for writing annotation lines that annotee can parse and turn into LogDog annotations.

See https://chromium.googlesource.com/chromium/tools/build/+/master/scripts/master/chromium_step.py and https://chromium.googlesource.com/infra/luci/luci-go/+/master/logdog/client/annotee/annotation/annotation.go

Check the above links on the semantics of each annotation.

Index

• func SeedStep(w io.Writer, name string) (int, error)
• func StepClosed(w io.Writer) (int, error)
• func StepCursor(w io.Writer, name string) (int, error)
• func StepException(w io.Writer) (int, error)
• func StepFailure(w io.Writer) (int, error)
• func StepLink(w io.Writer, label, url string) (int, error)
• func StepLogLine(w io.Writer, label, line string) (int, error)
• func StepNestLevel(w io.Writer, n int) (int, error)
• func StepStarted(w io.Writer) (int, error)

Functions

func SeedStep

func SeedStep(w io.Writer, name string) (int, error)

SeedStep prints a SEED_STEP annotation.

func StepClosed

func StepClosed(w io.Writer) (int, error)

StepClosed prints a STEP_CLOSED annotation.

func StepCursor

func StepCursor(w io.Writer, name string) (int, error)

StepCursor prints a STEP_CURSOR annotation.

func StepException

func StepException(w io.Writer) (int, error)

StepException prints a STEP_EXCEPTION annotation.

func StepFailure

func StepFailure(w io.Writer) (int, error)

StepFailure prints a STEP_FAILURE annotation.

func StepLink

func StepLink(w io.Writer, label, url string) (int, error)

StepLink prints a STEP_LINK annotation.

func StepLogLine

func StepLogLine(w io.Writer, label, line string) (int, error)

StepLogLine writes a line to a labeled log.

func StepNestLevel

func StepNestLevel(w io.Writer, n int) (int, error)

StepNestLevel prints a STEP_NEST_LEVEL annotation.

func StepStarted

func StepStarted(w io.Writer) (int, error)

StepStarted prints a STEP_STARTED annotation.