Ocaml Testing Template
Tutorials
Accompanying this repo are two tutorials:
The Makefile
The Makefile consists of a list of useful commands:
make install installs all the opam dependencies needed to use this repo
make lint lints your code and also checks it has been auto-formatted
make hook sets the git pre-commit hook to a hook that formats and lints your code.
make doc generates the documentation and copies it into a docs/ folder in the root of the repo`.
make coverage runs the test coverage, and generates HTML output of coverage in _coverage/
Generating Coveralls.io Reports
In your Circle CI project, you need to set the environment variable $COVERALLS_REPO_TOKEN that Coveralls provides you.
Generating Documentation
The repo uses GitHub Pages to display the generated documentation.
In the _circleci/config.yml file, you will need to change the "provision custom domain" step to your custom domain (or remove the step entirely).
The documentation deployment is run in a separate docker container in the CircleCI.
Be sure to update the git config user.email and git config user.name in the config file to your GitHub username and email.
For this to run successfully you need to grant CircleCI write access to your GitHub repo (by default the deploy key is read-only).