Index > workflow

Grit workflow management utilities.

HealthGauge: object

A title explaining the metric and a value between 0 and 100, representing how well the workflow is performing.

ProgressEstimate: object

A projection of ongoing workflow progress according to a named metric.

ProgressIncrement: object

estimate(data): Promise< void >

Estimate total work for the current workflow, computed using workflow internal logic.

Promise< void >

fail(settings): Promise< void >

Fail the workflow for a specific reason.

Promise< void >

increment(data): Promise< void >

Increment the progress of the current workflow by one unit, according to a metric initialized with estimate.

Promise< void >

markCheck(group): Promise< void >

Mark a check that was run

Promise< void >

markGroup(group): Promise< void >

Save a migration group to the current workflow

Promise< void >

markMatch(match): Promise< void >

Save a match result to the current workflow

Promise< void >

maybe_fail(settings): Promise< void >

Prompt the user with an error message and allow them to either abort or continue If the promise resolves, the user has chosen to continue the current workflow.

Promise< void >

track(data): Promise< void >

Save health metadata for the current workflow, computed using workflow internal logic.

Promise< void >

Generated using TypeDoc and typedoc-plugin-markdown