package current
Install
Dune Dependency
Authors
-
TThomas Leonard <talex5@gmail.com>
-
AAntonin Décimo <antonin@tarides.com>
-
TTim McGilchrist <timmcgil@gmail.com>
-
CCraig Ferguson <me@craigfe.io>
-
EEtienne MARAIS <etienne@maiste.fr>
-
AAnil Madhavapeddy <anil@recoil.org>
-
David Allsopp
-
EEwan Mellor <ewan@tarides.com>
-
KKate <kit.ty.kate@disroot.org>
-
MMark Elvers <mark.elvers@tunbury.org>
-
PPuneeth Chaganti <punchagan@muse-amuse.in>
-
LLucas Pluvinage <lucas@tarides.com>
-
NNavin Keswani <navin@novemberkilo.com>
-
TThomas Gazagnaire <thomas@gazagnaire.org>
-
Patrick Ferris
-
AArthur Wendling <art.wendling@gmail.com>
-
AAnurag Soni <anurag@sonianurag.com>
-
AAmbre Austen Suhamy <ambre@tarides.com>
-
HHannes Mehnert <hannes@mehnert.org>
-
BBen Andrew <benmandrew@gmail.com>
-
GGargi Sharma <gs051095@gmail.com>
-
JJonathan Coates <git@squiddev.cc>
-
JJules Aguillon <juloo.dsi@gmail.com>
-
MMagnus Skjegstad <magnus@skjegstad.com>
-
SShon Feder <shon.feder@gmail.com>
-
Ssmolck <46855713+smolck@users.noreply.github.com>
-
Ttatchi <corentin.leruth@gmail.com>
Maintainers
Sources
sha256=2329288bcbb455a3b8997f15d0090474e42274935379bc00d12abd22dcbf9990
sha512=27525c17c09fe90f2554701c60ef5d6f1d4b42f13f3c4245becbfecd0178f102739ec0a22732b2ed926510dd33d7d90a8f001df086e840279493182783d6c676
Description
OCurrent provides an OCaml eDSL for writing CI/CD pipelines.
It is used in ocaml-ci (which provides CI for OCaml projects on GitHub), and in docker-base-images (a pipeline that builds Docker images for various Linux distributions, OCaml compiler versions and CPU types, and pushes them to Docker Hub).
A pipeline is written much like you would write a one-shot sequential script, but OCurrent will automatically re-run steps when the inputs change, and will run steps in parallel where possible.
Published: 07 Feb 2024
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 (18)
- sqlite3
-
result
>= "1.5" -
re
>= "1.9.0" - prometheus
- ppx_deriving
- lwt-dllist
-
lwt
>= "5.6.1" -
logs
>= "0.7.0" -
fpath
>= "0.7.3" -
fmt
>= "0.8.9" - duration
-
current_incr
>= "0.6.1" -
conf-libev
os != "win32" -
cmdliner
>= "1.1.0" - bos
-
astring
>= "0.8.5" -
ocaml
>= "4.12.0" -
dune
>= "3.3"
Dev Dependencies (4)
-
odoc
with-doc -
prometheus-app
with-test & >= "1.2" -
alcotest-lwt
with-test & >= "1.2.0" -
alcotest
with-test & >= "1.2.0"
Used by (11)
- current-albatross-deployer
- current-web-pipelines
-
current_docker
>= "0.6.6" -
current_examples
>= "0.6.6" -
current_git
>= "0.6.6" -
current_github
>= "0.6.6" -
current_gitlab
>= "0.6.6" - current_ocluster
-
current_slack
>= "0.6.6" -
current_ssh
>= "0.6.6" -
current_web
>= "0.6.6"
Conflicts
None