OCaml Docs CI (aka docs-ci) is an OCurrent pipeline used for building the documentation for ocaml.org website. It uses the metadata from opam-repository to work out how to build documentation for individual packages using voodoo, the OCaml package documentation generator, and generates a HTML output suitable for ocaml.org server to present.
Get the code with:
git clone --recursive https://github.com/ocurrent/ocaml-docs-ci.git cd ocaml-docs-ci
Note: you need to clone with –recursive because this project uses submodules (it depends on some packages that aren’t released yet). If you forget,
git submodule update --init will fetch them.
Then you need an opam 2.1 switch using OCaml 4.14. Recommend using this command to setup a local switch just for
# Create a local switch with packages and test dependencies installed opam switch create . 4.14.1 --deps-only --with-test -y # Run the build dune build # Run the tests dune build @runtest
At a high level
docs-ci purpose is to compile the documentation of every package in the
opamverse. To do this is generates
a dependency universe. For each package (along with the version), the documentation is generated for it plus all of its
dependencies. This documentation is then collected into a
documentation set and provided to the ocaml.org service.
The voodoo tool defines the on disk format for the
For further details on how
docs-ci works read the pipeline diagram.
ocaml-docs-ci is deployed as into two environments, with ocurrent-deployer. The application is deployed as a series of Docker containers from a git branch.
|Environment||www||pipeline||git branch||data||voodoo branch|
OAuth integration provided by GitHub OAuth Apps hosted under the OCurrent organisation. See https://github.com/organizations/ocurrent/settings/applications
The infrastructure for
ocaml-docs-ci is managed via Ansible.
Contact @tmcgilchrist or @mtelvers if you need access or have questions.
To deploy a new version of
- Create a PR and wait for the GH Checks to run (ocaml-ci compiles the code and ocurrent-deployer checks it can build the Dockerfiles for the project)
- Test the changes on
stagingenvironment by git cherry picking the commits to that branch and pushing it
- Check deploy.ci.ocaml.org for
Follow a similar process for
live exercising extra caution as it could impact the live ocaml.org service.
The git history on
staging MUST be kept in sync with the default branch.
Those branches should be the same as
main plus or minus some commits from a PR.
TODO Provide cli over canpnp.
docs-ci is runable as:
dune exec -- ocaml-docs-ci \ --ocluster-submission cap/XXX.cap \ --ssh-host ci.mirage.io \ --ssh-user docs \ --ssh-privkey cap/id_rsa \ --ssh-pubkey cap/id_rsa.pub \ --ssh-folder /data/ocaml-docs-ci \ --ssh-endpoint https://ci.mirage.io/staging \ --jobs 6 \ --filter mirage \ --limit 6
A docker-compose.yml is provided to setup an entire
docs-ci environment including:
- ocluster scheduler
- ocluster Linux x86 worker
- nginx webserver for generated docs
- docs-ci built from the local git checkout
Run this command to create an environment:
$ docker-compose -f docker-compose.yml up
You should then be able to watch the pipeline in action at