progress

package
v0.51.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 25, 2026 License: MIT Imports: 0 Imported by: 0

Documentation

Overview

Package progress defines the transport-neutral event contract used by long-running WB operations. Engines never write terminal output directly.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Report 

func Report(reporter Reporter, event Event)

Report invokes reporter when configured.

Types

type Event 

type Event struct {
	Operation  string
	Phase      string
	Repository string
	Detail     string
	State      State
	Completed  int
	Total      int
	Wave       int
	Layer      int
}

Event is one progress observation. Completed and Total refer to repositories or releases; Wave and Layer identify ordered campaigns.

type Reporter 

type Reporter func(Event)

Reporter receives progress events. A nil reporter disables reporting.

type State 

type State string

State describes the lifecycle of one operation or repository phase. 

const (
	Started   State = "started"
	Running   State = "running"
	Completed State = "completed"
	Failed    State = "failed"
	Waiting   State = "waiting"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.