progress

package

v0.19.0 Latest Latest Go to latest Published: Apr 4, 2024 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	StatusSuccess    = "success"
	StatusFailed     = "failed"
	StatusInProgress = "in_progress"
	StatusPending    = "pending"
)

View Source

var ErrPipeline = errors.New("pipeline has encountered an error")

func EventToPipeline(event *sdk.EventItem, options *Options) (*sdk.PipelineItem, error)

func Pipeline(pipelineID string, options *Options) error

type Options struct {
	Interval time.Duration
}

func NewOptions() *Options

type PipelineStatus int

const (
	PipelineWorking PipelineStatus = iota
	PipelineFinished
	PipelineFailed
	PipelineUnknownState
)

type PipelineSyncer func() (*sdk.PipelineItem, error)

type Progress struct {
	Options Options
	// contains filtered or unexported fields
}

func NewPipeline(options Options) *Progress

func (p *Progress) Start()

func (p *Progress) Stop()

func (p *Progress) Update(pipelineSync PipelineSyncer) error

func (p *Progress) UpdatePipeline(pipeline *sdk.PipelineItem) (bool, error)

type UpdateStatus int

const (
	Failed UpdateStatus = iota
	Success

	Synced
)