package current_gitlab
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=2329288bcbb455a3b8997f15d0090474e42274935379bc00d12abd22dcbf9990
sha512=27525c17c09fe90f2554701c60ef5d6f1d4b42f13f3c4245becbfecd0178f102739ec0a22732b2ed926510dd33d7d90a8f001df086e840279493182783d6c676
Description
OCurrent provides an OCaml eDSL for writing CI/CD pipelines.
This package provides primitives for interacting with GitLab. It can monitor and clone remote GitLab repositories, and can push GitLab status messages to show the results of testing PRs and branches.
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 (17)
- yojson
-
rresult
>= "0.6.0"
-
result
>= "1.5"
- ptime
-
prometheus
>= "0.7"
-
ppx_deriving_yojson
>= "3.6.1"
-
lwt
>= "5.6.1"
-
logs
>= "0.7.0"
-
gitlab-unix
>= "0.1.8"
-
fmt
>= "0.8.9"
-
cohttp-lwt-unix
>= "4.0.0"
-
cmdliner
>= "1.1.0"
-
ocaml
>= "4.12.0"
-
current_web
= version
-
current_git
= version
-
current
= version
-
dune
>= "3.3"
Dev Dependencies (1)
-
odoc
with-doc
Used by (1)
-
current_examples
>= "0.6.6"
Conflicts
None