package current
-
current.fs
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package current
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
The most general API. BUILDER and PUBLISHER are just special cases of this.
include OPERATION
A short and unique name for this operation, used as a filename component and database key. e.g. "docker-build"
module Key : WITH_DIGESTThe id, Key.t pair uniquely identifies the operation.
module Value : WITH_DIGESTA second input value, which is not part of the key (so there can be only one value for any key at one time). For outputs, this is used to hold the value to which the output should be set. For builds, non-essential inputs can be placed here instead of in the key so that the old outcome can be latched for minor changes. For example, when testing a Git commit the commit to test would be the key, but the latest version of the test platform might be the value.
module Outcome : WITH_MARSHALThe output of the pipeline stage.
val run :
t ->
Current.Job.t ->
Key.t ->
Value.t ->
Outcome.t Current.or_error Lwt.trun t j k v performs the operation. Call Job.start j once any required resources have been acquired. Log messages can be written to j.
This affects what happens if we're in the process of outputting a value and then we decide to output a different value instead. If true, the old operation will be cancelled immediately. If false, the old operation will run to completion first.