Pipeline (FsMake)

Pipeline Module

Namespace: FsMake
Assembly: FsMake.dll

Module for creating and working with a Pipeline.

Types

Type	Description
Builder	A Pipeline computation expression builder.
RunArgs	Required arguments for running a Pipeline.

Functions and values

Function or value	Description
`create name` Full Usage: `create name` Parameters: name : `string` - The name of the pipeline. Returns: `Builder` A Builder.	Creates a pipeline using a Builder computation expression. name : `string` The name of the pipeline. Returns: `Builder` A Builder. Example let emptyStep = Step.create "emptyStep" { () } let pipeline = Pipeline.create "pipeline" { run emptyStep }
`createFrom pipeline name` Full Usage: `createFrom pipeline name` Parameters: pipeline : `Pipeline` - A Pipeline to use as a base to build upon. A new Pipeline will be created from this one and have stages appended. name : `string` - The name of the new Pipeline. Returns: `Builder` A Builder.	Creates a pipeline using a Builder computation expression. The `pipeline` parameter is an exsting pipeline to use as a base. This does not modify the existing Pipeline, it returns a new Pipeline with additional stages. pipeline : `Pipeline` A Pipeline to use as a base to build upon. A new Pipeline will be created from this one and have stages appended. name : `string` The name of the new Pipeline. Returns: `Builder` A Builder.
`run args pipeline` Full Usage: `run args pipeline` Parameters: args : `RunArgs` - Required arguments. pipeline : `Pipeline` - The Pipeline to run. Returns: `bool` `true` if the pipeline succeeded, `false` if there was any failure.	Runs a pipeline. args : `RunArgs` Required arguments. pipeline : `Pipeline` The Pipeline to run. Returns: `bool` `true` if the pipeline succeeded, `false` if there was any failure.