package current_incr
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=85d65779b104da6ccfdb33b65fc6d2492dd3942d9fd74127059cb6f850684a17
sha512=6cc24530a9e58dcf32cf00b5ed17e93cb949786e30d625fbc07b24f380e536d6a4e7c2902ede86af3ddf2ac48135efb9483144514f40d298adab11be4f8c473d
Description
This is a small, self-contained library for self-adjusting (incremental) computations. It was written for OCurrent, but can be used separately too.
It is similar to Jane Street's incremental library, but much smaller and has no external dependencies.
It is also similar to the react library, but the results do not depend on the behaviour of the garbage collector. In particular, functions stop being called as soon as they are no longer needed.
Published: 23 Dec 2020
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.