Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ocurrent/ocurrent

Keeps things up-to-date (a CI/CD pipeline OCaml eDSL)
https://github.com/ocurrent/ocurrent

ci edsl ocaml

Last synced: 3 months ago
JSON representation

Keeps things up-to-date (a CI/CD pipeline OCaml eDSL)

Awesome Lists containing this project

README

        

# OCurrent

[![OCaml-CI Build Status](https://img.shields.io/endpoint?url=https%3A%2F%2Fci.ocamllabs.io%2Fbadge%2Focurrent%2Focurrent%2Fmaster&logo=ocaml)](https://ci.ocamllabs.io/github/ocurrent/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](https://github.com/ocurrent/docker-base-images) and
[ocaml-ci](https://github.com/ocurrent/ocaml-ci/), which is the CI that tests this repository itself.

## Documentation

The [OCurrent docs](doc/index.md) contains user documentation and examples.
In particular, you might like to start by reading about the
[example pipelines](doc/example_pipelines.md) or how to [write your own plugins](doc/writing_plugins.md).

For technical docs, see the [API Documentation](https://ocurrent.github.io/ocurrent/index.html).

## Licensing

OCurrent is licensed under the Apache License, Version 2.0.
See [LICENSE](LICENSE) for the full license text.