Liking cljdoc? Tell your friends :D

lambdacd.execution.core

Entrypoint into the pipeline/step execution engine.

Entrypoint into the pipeline/step execution engine.

execute-step

(execute-step args [ctx step])
(execute-step args ctx step)

Execute a single step within a pipeline execution. Takes the arguments to pass to the step, the ctx and the step-function to call. Often used when implementing container steps (i.e. steps that call other, child steps).

Execute a single step within a pipeline execution.
Takes the arguments to pass to the step, the ctx and the step-function to call.
Often used when implementing container steps (i.e. steps that call other, child steps).
sourceraw docstring

execute-steps

(execute-steps steps args ctx & opts)

Execute a number of steps in a particular way (configured by opts). Usually used when implementing container steps (i.e. steps that call other, child steps).

Opts:

  • :step-results-producer A function that can execute a set of steps and return a step result in the end. Defaults to serial execution
  • :is-killed An atom with vaule true or false if the parent step needs control over when child steps are killed. Optional
  • :unify-results-fn A function that takes a collection of step results and returns a single step result that will be the result of the step while it is in progress. Used to control the parent
  • :retrigger-predicate A function that takes a steps context and the step itself and returns a keyword on what to do when retriggering: :run if the step should just run normally, :rerun if we rerun a step that ran before or :mock if we just mock the steps run by returning the previous result. Defaults to behavior that makes sense of steps run in sequence.
Execute a number of steps in a particular way (configured by opts). Usually used when implementing container steps (i.e. steps that call other, child steps).

Opts:

* `:step-results-producer` A function that can execute a set of steps and return a step result in the end. Defaults to serial execution
* `:is-killed` An atom with vaule true or false if the parent step needs control over when child steps are killed. Optional
* `:unify-results-fn` A function that takes a collection of step results and returns a single step result that will be the result of the step while it is in progress. Used to control the parent
* `:retrigger-predicate` A function that takes a steps context and the step itself and returns a keyword on what to do when retriggering: `:run` if the step should just run normally, `:rerun` if we rerun a step that ran before or `:mock` if we just mock the steps run by returning the previous result. Defaults to behavior that makes sense of steps run in sequence.
sourceraw docstring

kill-step

(kill-step ctx build-number step-id)

Send an event to kill a particular step and return immediately.

Send an event to kill a particular step and return immediately.
sourceraw docstring

retrigger-pipeline

(retrigger-pipeline pipeline
                    context
                    build-number
                    step-id-to-run
                    next-build-number)

Retriggers a previous build of the pipeline, starting from a particular step-id. Returns the full results of the pipeline execution (see run-pipeline for details)

Retriggers a previous build of the pipeline, starting from a particular step-id.
Returns the full results of the pipeline execution (see run-pipeline for details)
sourceraw docstring

retrigger-pipeline-async

(retrigger-pipeline-async pipeline
                          context
                          build-number
                          step-id-to-run)

Retriggers a previous build of the pipeline asynchronously and returning only the build number of the new pipeline-execution.

Retriggers a previous build of the pipeline asynchronously and returning only the build number of the new pipeline-execution.
sourceraw docstring

run-pipeline

(run-pipeline pipeline ctx)

Execute a complete run of the pipeline. Returns with the full result of the pipeline execution:

> (run-pipeline pipeline ctx)
{:status  :success
 :outputs {[1] {:status :success}
           [2] {:status :success
                :outputs {[1 2} {:status :success}}
Execute a complete run of the pipeline.
Returns with the full result of the pipeline execution:
```clojure
> (run-pipeline pipeline ctx)
{:status  :success
 :outputs {[1] {:status :success}
           [2] {:status :success
                :outputs {[1 2} {:status :success}}
```
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close