package current-web-pipelines

  1. Overview
  2. Docs

Module Current_web_pipelines.StateSource

This module contains a generic layered state that can be rendered using the Web module.

Sourcetype 'output job_result = ('output, [ `Active of Current_term.Output.active | `Msg of string | `Cancelled | `Blocked | `Skipped_failure | `Skipped of string ]) result

Job data

Sourcetype 'output job = {
  1. result : 'output job_result;
  2. metadata : Current.Metadata.t option;
}

Job data and metadata

Sourcetype ('output, 'node_metadata) job_tree_node =
  1. | Item of 'output job
  2. | Group of ('output, 'node_metadata) job_tree list
Sourceand ('output, 'node_metadata) job_tree = {
  1. node : ('output, 'node_metadata) job_tree_node;
  2. metadata : 'node_metadata;
}

A tree of jobs

Sourceval job_tree_item : 'node_metadata -> ?metadata:Current.Metadata.t -> 'output job_result -> ('output, 'node_metadata) job_tree

Create a single leaf job

Sourceval job_tree_group : 'node_metadata -> ('output, 'node_metadata) job_tree list -> ('output, 'node_metadata) job_tree

Group jobs in a node

Sourcetype ('output, 'node_metadata, 'stage_metadata) stage = {
  1. jobs : ('output, 'node_metadata) job_tree list;
  2. metadata : 'stage_metadata;
}

A stage is a group of trees

Sourceval stage : 'stage_metadata -> ('output, 'node_metadata) job_tree list -> ('output, 'node_metadata, 'stage_metadata) stage
Sourcetype ('output, 'node_metadata, 'stage_metadata, 'pipeline_metadata) pipeline = {
  1. stages : ('output, 'node_metadata, 'stage_metadata) stage list;
  2. metadata : 'pipeline_metadata;
}

A pipeline is a sequence of stages

Sourceval pipeline : 'pipeline_metadata -> ('output, 'node_metadata, 'stage_metadata) stage list -> ('output, 'node_metadata, 'stage_metadata, 'pipeline_metadata) pipeline
Sourceval job_tree_status : node_map_status:('node_metadata -> 'output job_result -> 'output job_result) -> ('output, 'node_metadata) job_tree -> 'output job_result

Aggregated tree status

Sourceval stage_status : node_map_status:('node_metadata -> 'output job_result -> 'output job_result) -> ('output, 'node_metadata, _) stage -> 'output job_result

Aggregated stage status

Sourceval pipeline_status : node_map_status:('node_metadata -> 'output job_result -> 'output job_result) -> ('output, 'node_metadata, _, _) pipeline -> 'output job_result

Aggregated pipeline status

Sourceval map : ([ `Children of 'new_node_metadata list | `Leaf of 'output job ] -> 'node_metadata -> 'new_node_metadata) -> ('new_node_metadata list -> 'stage_metadata -> 'new_stage_metadata) -> ('new_stage_metadata list -> 'pipeline_metadata -> 'new_pipeline_metadata) -> ('output, 'node_metadata, 'stage_metadata, 'pipeline_metadata) pipeline -> ('output, 'new_node_metadata, 'new_stage_metadata, 'new_pipeline_metadata) pipeline

map fn_leaf fn_node fn_stage fn_pipeline pipeline transforms the metadata at every stage. Each function takes the new metadata of the lower stages and the current metadata and should return the new metadata.

Sourceval marshal : ('output -> string) -> ('new_node_metadata -> string) -> ('new_stage_metadata -> string) -> ('new_pipeline_metadata -> string) -> ('output, 'new_node_metadata, 'new_stage_metadata, 'new_pipeline_metadata) pipeline -> string
Sourceval unmarshal : (string -> 'output) -> (string -> 'new_node_metadata) -> (string -> 'new_stage_metadata) -> (string -> 'new_pipeline_metadata) -> string -> ('output, 'new_node_metadata, 'new_stage_metadata, 'new_pipeline_metadata) pipeline