package current_github

All checked builds pass
  1. Overview
  2. Docs
GitHub plugin for OCurrent

Install

dune-project
 Dependency

Authors

Maintainers

Sources

current-0.6.2.tbz
sha256=ed312cab4ce8d13b9547ee2f935a6954f1d5211de1c22d44d85baaeb9f5fca9d
sha512=c2981a2c7f05bd6f235662b74ee3a679cc395be3d2cca808fac3dc562d6307e8bfe05efff40f42fa4738443cc2fe13929bab9d815c43d741950e5e0e1e6da7a6

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.

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 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. uri >= "4.0.0"
  2. tyxml >= "4.4.0"
  3. rresult >= "0.6.0"
  4. result >= "1.5"
  5. prometheus >= "0.7"
  6. ppx_deriving_yojson >= "3.6.1"
  7. logs >= "0.7.0"
  8. cstruct >= "5.2.0"
  9. cmdliner >= "1.1.0"
  10. base64 >= "3.4.0"
  11. astring >= "0.8.5"
  12. github-unix >= "4.4.0"
  13. dune >= "2.9"
  14. tls >= "0.11.0" & < "1.0.0"
  15. x509 >= "0.10.0"
  16. hex >= "1.4.0"
  17. mirage-crypto-pk < "1.0.0"
  18. mirage-crypto < "1.0.0"
  19. cohttp-lwt-unix >= "4.0.0"
  20. yojson
  21. ptime
  22. duration
  23. lwt
  24. fmt >= "0.8.9"
  25. ocaml >= "4.08.0"
  26. current_web = version
  27. current_git = version
  28. current = version

Dev Dependencies

None

Optional Dependencies

None

Used by (2)

  1. current_examples = "0.6.2"
  2. current_ocluster = "0.2"

Conflicts

None

Build status

Results of building current_github with each compiler on check.ci.ocaml.org, run of against opam-repository 78c202b. 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.

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 (this version) 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