runQuarkdown

fun runQuarkdown(executionStrategy: PipelineExecutionStrategy, cliOptions: CliOptions, pipelineOptions: PipelineOptions): ExecutionOutcome

Executes a complete Quarkdown pipeline.

This is the entry point used by both the CLI and any in-process embedder. On any PipelineException the exception propagates to the caller, for embedders to catch and handle. If CliOptions.timeoutSeconds is set and expires, an ExecutionTimeoutException is raised instead.

Return

the outcome of the executed pipeline, carrying the produced resource and directory (if any)

Parameters

executionStrategy

launch strategy of the pipeline, e.g. from file or REPL

cliOptions

options that define the behavior of the CLI, especially I/O and the execution timeout

pipelineOptions

options that define the behavior of the pipeline

Throws

if the pipeline fails and its error handler rethrows the error

if CliOptions.timeoutSeconds is set and the execution exceeds it