package current_github
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=cf7067dcbe09d054ff35fa22a0bfb1c9bdb6923784c686d51d0f1e599b853cd0
sha512=a80560c937ab760e032ad4a508c591d91b0aed802e6c5dd8469a28f8e4e75014ff88f89f21ddb3bde86a9379839f43a38f4f39a946621a4e5847695d1ca20f98
Description
OCurrent provides an OCaml eDSL for writing CI/CD pipelines.
This package provides primitives for interacting with GitHub. It can monitor and clone remote GitHub repositories, and can push GitHub status messages to show the results of testing PRs and branches.
Published: 02 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)
-
uri
>= "4.0.0" -
tyxml
>= "4.4.0" -
rresult
>= "0.6.0" -
result
>= "1.5" -
prometheus
>= "0.7" -
ppx_deriving_yojson
>= "3.6.1" -
logs
>= "0.7.0" -
cstruct
>= "5.2.0" -
cmdliner
>= "1.1.0" -
base64
>= "3.4.0" -
astring
>= "0.8.5" -
github-unix
>= "4.4.0" -
dune
>= "2.9" -
tls
>= "0.11.0" & < "1.0.0" -
x509
>= "0.10.0" -
hex
>= "1.4.0" -
mirage-crypto-pk
< "1.0.0" -
mirage-crypto
< "1.0.0" -
cohttp-lwt-unix
>= "4.0.0" - yojson
- ptime
- duration
- lwt
-
fmt
>= "0.8.9" -
ocaml
>= "4.08.0" -
current_web
= version -
current_git
= version -
current
= version
Dev Dependencies
None
Used by (2)
-
current_examples
= "0.6.1" -
current_ocluster
= "0.2"
Conflicts
None