package current_git

  1. Overview
  2. Docs
Git plugin for OCurrent

Install

Dune 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 Git. It can pull from remote repositories, or monitor local ones for changes.

Published: 21 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 (17)

  1. mirage-crypto >= "0.8.0" & < "1.0.0"
  2. cstruct >= "6.0.0"
  3. result >= "1.5"
  4. logs >= "0.7.0"
  5. fpath >= "0.7.3"
  6. bos >= "0.2.0"
  7. astring >= "0.8.5"
  8. dune >= "2.9"
  9. yojson
  10. ppx_deriving_yojson >= "3.5.1"
  11. irmin-watcher
  12. lwt
  13. ppx_deriving
  14. fmt >= "0.8.9"
  15. conf-git
  16. ocaml >= "4.08.0"
  17. current = version

Dev Dependencies (1)

  1. mdx with-test

Used by (5)

  1. current_docker = "0.6.2"
  2. current_examples = "0.6.2"
  3. current_github = "0.6.2"
  4. current_gitlab = "0.6.2"
  5. current_ocluster < "0.2.1"

Conflicts

None

OCaml

Innovation. Community. Security.