package current_examples

  1. Overview
  2. Docs
Example pipelines for OCurrent

Install

Dune Dependency

github.com Readme Changelog Apache-2.0 License Edit opam file Versions (10)

Authors

  1. T
    talex5@gmail.com

Maintainers

  1. T
    talex5@gmail.com

Sources

current-0.6.1.tbz
sha256=cf7067dcbe09d054ff35fa22a0bfb1c9bdb6923784c686d51d0f1e599b853cd0
sha512=a80560c937ab760e032ad4a508c591d91b0aed802e6c5dd8469a28f8e4e75014ff88f89f21ddb3bde86a9379839f43a38f4f39a946621a4e5847695d1ca20f98

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: 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)

  1. prometheus-app >= "1.0" & < "1.2"
  2. yojson >= "1.7.0"
  3. uri >= "4.0.0"
  4. routes >= "0.8.0"
  5. result >= "1.5"
  6. prometheus >= "0.7"
  7. ppx_deriving_yojson >= "3.6.1"
  8. ppx_deriving >= "5.1"
  9. logs >= "0.7.0"
  10. fpath >= "0.7.3"
  11. dockerfile >= "7.0.0"
  12. capnp-rpc-net >= "0.8.0"
  13. capnp-rpc-lwt >= "0.8.0"
  14. capnp-rpc >= "0.8.0"
  15. dune >= "2.9"
  16. capnp-rpc-unix >= "0.5"
  17. current_rpc = version
  18. current_docker = version
  19. current_gitlab = version
  20. current_github = version
  21. current_git = version
  22. current_web = version
  23. current = version
  24. duration
  25. cmdliner >= "1.1.0"
  26. lwt
  27. fmt >= "0.8.9"
  28. ocaml >= "4.08.0"

Dev Dependencies (1)

  1. mdx with-test & < "2.4"

Used by

None

Conflicts

None