package current

You can search for identifiers within the package.

in-package search v0.2.0

Pipeline language for keeping things up-to-date

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (3)

Authors

T

talex5@gmail.com

Maintainers

T

talex5@gmail.com

Sources

current-v0.5.tbz

sha256=f8c884318a46a568d965c7e8bac00dfe2339efac04ca6f0cbabef916d8b917ca

sha512=e0633239a7d02cdde6264db96c39ed7e3d1adf3a7f09bb25ad002d388f203b561e8c808daee90539bc0ee15c547d2ab4bef1789dcc9c22ed00b151bad0083f64

doc/current.cache/Current_cache/Output/argument-1-P/index.html

Parameter `Output.P`

include S.OPERATION

type t

Extra context or configuration information (e.g. credentials to access a remote service).

val id : string

A short and unique name for this operation, used as a filename component and database key. e.g. "docker-build"

module Key : S.WITH_DIGEST

The id, Key.t pair uniquely identifies the operation.

module Value : S.WITH_DIGEST

The value to publish.

module Outcome : S.WITH_MARSHAL

Extra information about the result, if any. Usually this is just Current.Unit.

val publish : 
  t ->
  Current.Job.t ->
  Key.t ->
  Value.t ->
  Outcome.t Current.or_error Lwt.t

publish t j k v sets output k to value v. Call Job.start j once any required resources have been acquired. Log messages can be written to j.

val pp : (Key.t * Value.t) Fmt.t

Describe the operation. e.g. "docker push $tag".

val auto_cancel : bool

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.