package current_github

  1. Overview
  2. Docs
GitHub plugin for OCurrent

Install 

dune-project
 Dependency

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

Authors

  1. T
    Thomas Leonard <[email protected]>
  2. A
    Antonin Décimo <[email protected]>
  3. T
    Tim McGilchrist <[email protected]>
  4. C
    Craig Ferguson <[email protected]>
  5. E
    Etienne MARAIS <[email protected]>
  6. A
    Anil Madhavapeddy <[email protected]>
  7. David Allsopp
  8. E
    Ewan Mellor <[email protected]>
  9. K
    Kate <[email protected]>
  10. M
    Mark Elvers <[email protected]>
  11. P
    Puneeth Chaganti <[email protected]>
  12. L
    Lucas Pluvinage <[email protected]>
  13. N
    Navin Keswani <[email protected]>
  14. T
    Thomas Gazagnaire <[email protected]>
  15. Patrick Ferris
  16. A
    Arthur Wendling <[email protected]>
  17. A
    Anurag Soni <[email protected]>
  18. A
    Ambre Austen Suhamy <[email protected]>
  19. B
    Ben Andrew <[email protected]>
  20. G
    Gargi Sharma <[email protected]>
  21. J
    Jonathan Coates <[email protected]>
  22. J
    Jules Aguillon <[email protected]>
  23. M
    Magnus Skjegstad <[email protected]>
  24. S
    Shon Feder <[email protected]>
  25. S
    smolck <[email protected]>
  26. T
    tatchi <[email protected]>

Maintainers

  1. M
    Mark Elvers <[email protected]>

Sources

ocurrent-0.8.0.tbz
md5=2c246c189fe506c76b588d0d787b7fd5
sha512=4dc944e694b3f0063db45dff177120f8515d8ac498ec21b5925aa21755ac0f8e51b74e710638976a919245392e6a54d8ff277cabec95e708adbb57a02f5a0e8e

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

Dev Dependencies (1)

  1. odoc with-doc

Used by (2)

  1. current_examples >= "0.8.0"
  2. current_ocluster >= "0.2"

Conflicts

None