package current_examples

  1. Overview
  2. Docs
Example pipelines for OCurrent

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (8)

Authors

  1. T
    talex5@gmail.com

Maintainers

  1. T
    talex5@gmail.com

Sources

current-v0.5.tbz
sha256=f8c884318a46a568d965c7e8bac00dfe2339efac04ca6f0cbabef916d8b917ca
sha512=e0633239a7d02cdde6264db96c39ed7e3d1adf3a7f09bb25ad002d388f203b561e8c808daee90539bc0ee15c547d2ab4bef1789dcc9c22ed00b151bad0083f64

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.

Added to opam-repository:

README

OCurrent

OCaml-CI Build Status

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 wiki 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 (27)

  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" & < "2.0"
  13. capnp-rpc-lwt >= "0.8.0"
  14. capnp-rpc >= "0.8.0"
  15. dune >= "2.0"
  16. capnp-rpc-unix >= "0.5" & < "2.0"
  17. current_rpc = version
  18. current_docker = version
  19. current_github = version
  20. current_git = version
  21. current_web = version
  22. current = version
  23. duration
  24. cmdliner
  25. lwt
  26. fmt >= "0.8.9"
  27. ocaml >= "4.08.0"

Dev Dependencies

None

Used by

None

Conflicts

None

Build status

Results of building current_examples with each compiler on check.ci.ocaml.org, run of against opam-repository 7cdc698. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

This version is not in the latest run; the versions below are.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.8.0 n/a good good good good
0.6.2 good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure