package current_github

  1. Overview
  2. Docs
GitHub plugin for OCurrent

Install

Dune Dependency

Authors

Maintainers

Sources

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

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: 06 Jun 2021

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 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 (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. cohttp-lwt >= "2.5.4"
  10. cohttp >= "2.5.4"
  11. cmdliner >= "1.0.4"
  12. base64 >= "3.4.0"
  13. astring >= "0.8.5"
  14. dune >= "2.0"
  15. tls >= "0.11.0" & < "1.0.0"
  16. x509 >= "0.10.0"
  17. mirage-crypto-pk < "1.0.0"
  18. mirage-crypto < "1.0.0"
  19. cohttp-lwt-unix >= "2.5.4"
  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

Used by (1)

  1. current_examples = "0.5"

Conflicts

None

OCaml

Innovation. Community. Security.