Documentation
¶
Overview ¶
Package programstatus reports what bk is doing to the terminal using the Program Status Protocol (OSC 7501), so terminals can show whether bk is working, waiting on the user, or finished.
Reports go to stderr and are only sent when stderr is a terminal outside CI. Set BUILDKITE_PROGRAM_STATUS=false to disable them or =true to always send them.
See: https://www.superlogical.com/rex/docs/build/program-status
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Block ¶
func Block(kind ansi.ProgramStatusKind, msg string) (unblock func())
Block reports that bk is blocked on the user. Call the returned function once the user has answered to restore the status reported before blocking.
func Finish ¶
Finish reports how long-running work ended, leaving a record the user can come back to: done with msg if err is nil, idle if the user canceled it, and error otherwise.
func Report ¶
func Report(s ansi.ProgramStatus)
Report sends s as the status of bk, tagged with the bk app name.
Types ¶
This section is empty.
Source Files