Documentation
¶
Index ¶
- Constants
- func Output(out io.Writer, interactive bool) io.Writer
- type Campaign
- type Checks
- func (progress *Checks) Fail(err error)
- func (progress *Checks) Finish(result githubchecks.PullRequestWaitResult)
- func (progress *Checks) FinishOperation(message string)
- func (progress *Checks) OperationReporter(operation string) progresspkg.Reporter
- func (progress *Checks) Report(event githubchecks.PullRequestWaitProgress)
- func (progress *Checks) Start(repository, pullRequest, target, head string)
- func (p *Checks) Update(message string)
- type Live
Constants ¶
const Heartbeat = 10 * time.Second
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Campaign ¶
type Campaign struct {
// contains filtered or unexported fields
}
Campaign adapts typed engine events to the shared one-line terminal renderer. Machine-readable command output remains exclusively on stdout.
func (*Campaign) Report ¶
func (p *Campaign) Report(event engineprogress.Event)
func (*Campaign) Reporter ¶
func (p *Campaign) Reporter() engineprogress.Reporter
type Checks ¶
type Checks struct {
// contains filtered or unexported fields
}
func NewChecksWithHeartbeat ¶
func (*Checks) Finish ¶
func (progress *Checks) Finish(result githubchecks.PullRequestWaitResult)
func (*Checks) FinishOperation ¶
func (*Checks) OperationReporter ¶
func (progress *Checks) OperationReporter(operation string) progresspkg.Reporter
func (*Checks) Report ¶
func (progress *Checks) Report(event githubchecks.PullRequestWaitProgress)
type Live ¶
type Live struct {
// contains filtered or unexported fields
}
Live renders one replaceable terminal line. Commands keep their machine-readable report on stdout and send short-lived human progress here, on stderr. The mutex lets parallel repository workers report safely.
func NewLiveWithHeartbeat ¶
func (*Live) PrintLine ¶
PrintLine writes one immediate, already-terminated line and returns without touching the replaceable-line/elapsed-suffix/heartbeat machinery the rest of this type provides. Use it for callers whose message already carries its own timing — `wb run`'s queued/admitted/done receipts compute their own elapsed durations, so wrapping them in withElapsed would print a redundant second duration.
Source Files