Welcome to OCurrent
A Pipeline language for keeping things up-to-date
OCurrent allows you to specify a workflow / pipeline for keeping things up-to-date.
For example, the pipeline shown above fetches the head of a GitHub repository’s
master branch, builds it, runs the tests, and deploys the binary if the tests
pass. When a new commit is pushed, it runs the pipeline again.
let pipeline ~repo () = let src = Git.Local.head_commit repo in let base = Docker.pull ~schedule:weekly "ocaml/opam2" in let build ocaml_version = let dockerfile = let+ base = base in dockerfile ~base ~ocaml_version in Docker.build ~label:ocaml_version ~pull:false ~dockerfile (`Git src) |> Docker.tag ~tag:(Fmt.strf "example-%s" ocaml_version) in Current.all [ build "4.07"; build "4.08" ]
Another use might be to keep the GitHub build status of each PR in your Git repository showing the result of fetching, building and testing the PR’s head commit. If the head commit changes, the result must be recalculated.
An OCurrent pipeline is written using an OCaml eDSL. When OCurrent evaluates it, it records the inputs used (e.g. the current set of open PRs and the head of each one), monitors them, and automatically recalculates when an input changes.
The OCurrent wiki contains documentation and examples. In particular, you might like to start by reading about the example pipelines or how to write your own plugins.
Larger uses of OCurrent include the OCaml Docker base image builder and the CI pipeline for OCaml platform projects.