package current_examples
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ed312cab4ce8d13b9547ee2f935a6954f1d5211de1c22d44d85baaeb9f5fca9d
sha512=c2981a2c7f05bd6f235662b74ee3a679cc395be3d2cca808fac3dc562d6307e8bfe05efff40f42fa4738443cc2fe13929bab9d815c43d741950e5e0e1e6da7a6
Description
OCurrent provides an OCaml eDSL for writing CI/CD pipelines.
This package provides some example pipelines. It exists mainly to test the integration of various OCurrent plugins.
Published: 21 Jun 2022
README
OCurrent
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.
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.
Larger uses of OCurrent include the OCaml Docker base image builder and ocaml-ci, which is the CI that tests this repository itself.
Documentation
The OCurrent docs contains user documentation and examples. In particular, you might like to start by reading about the example pipelines or how to write your own plugins.
For technical docs, see the API Documentation.
Licensing
OCurrent is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
Dependencies (28)
-
prometheus-app
>= "1.2"
-
yojson
>= "1.7.0"
-
uri
>= "4.0.0"
-
routes
>= "0.8.0"
-
result
>= "1.5"
-
prometheus
>= "0.7"
-
ppx_deriving_yojson
>= "3.6.1"
-
ppx_deriving
>= "5.1"
-
logs
>= "0.7.0"
-
fpath
>= "0.7.3"
-
dockerfile
>= "7.0.0"
-
capnp-rpc-net
>= "0.8.0"
-
capnp-rpc-lwt
>= "0.8.0"
-
capnp-rpc
>= "0.8.0"
-
dune
>= "2.9"
-
capnp-rpc-unix
>= "0.5"
-
current_rpc
= version
-
current_docker
= version
-
current_gitlab
= version
-
current_github
= version
-
current_git
= version
-
current_web
= version
-
current
= version
- duration
-
cmdliner
>= "1.1.0"
- lwt
-
fmt
>= "0.8.9"
-
ocaml
>= "4.08.0"
Dev Dependencies (1)
-
mdx
with-test & < "2.4"
Used by
None
Conflicts
None