https://github.com/mjambon/ocaml-layer

Make your own OCaml base image for fast CI jobs
https://github.com/mjambon/ocaml-layer

docker ocaml opam

Last synced: 2 months ago
JSON representation

Make your own OCaml base image for fast CI jobs

• Host: GitHub
• URL: https://github.com/mjambon/ocaml-layer
• Owner: mjambon
• License: unlicense
• Created: 2020-07-18T19:22:12.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-19T02:51:34.000Z (8 months ago)
• Last Synced: 2024-10-04T15:45:49.809Z (3 months ago)
• Topics: docker, ocaml, opam
• Language: Shell
• Homepage:
• Size: 43.9 KB
• Stars: 14
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
ocaml-layer

==

[![CircleCI badge](https://circleci.com/gh/mjambon/ocaml-layer.svg?style=svg)](https://app.circleci.com/pipelines/github/mjambon/ocaml-layer)

Bring your team's OCaml CI jobs down to 1 min.

Motivation

--

The goal is to set up a cached build environment on which your team can

compile and test their own OCaml software, quickly every time.

* Pre-install all the external dependencies - opam packages and more.

* Start from the base Docker image of your choice.

* It's admin-friendly. Maintenance requires no OCaml knowledge.

* Customize by forking and editing this git repo.

* It's Docker. Reproducible locally and not tied to a CI vendor's caching.

Usage

--

For evaluation purposes, you can simply run `make` and watch

an image being built with some default settings.

For actual use, follow these steps:

1. Create your own Docker repository on

   [Docker Hub](https://hub.docker.com/) or some other registry.

2. Fork this git repository.

3. Add packages to the lists in `common-config.sh`.

4. Create or edit one configuration file per container, in `configs/`.

5. Adjust the `SELECTED_CONFIGS` variable in the `Makefile`.

6. Run `make` to build the Docker images.

7. Run `make push` to upload the images.

8. Use these images as base images in your CI jobs.

You can reuse and adapt the [CircleCI config](.circleci/config.yml) of

this repo to rebuild your images on a weekly basis or so.

Example

--

The config I use for my own needs is

[common-config.sh](https://github.com/mjambon/ocaml-layer/blob/mjambon/common-config.sh)

and [configs](https://github.com/mjambon/ocaml-layer/tree/mjambon/configs).

The Docker images end up on Docker Hub:

[minimum OCaml version](https://hub.docker.com/r/mjambon/mj-ocaml-4.02/tags)

and [latest OCaml](https://hub.docker.com/r/mjambon/mj-ocaml/tags).

They are updated weekly using CircleCI

([config](https://github.com/mjambon/ocaml-layer/blob/mjambon/.circleci/config.yml)).

Suggestions

--

* If you're an individual open-source developer, you may want to

  target two versions of OCaml: the minimum version that you're

  willing to support and the latest version.

* The [ocaml/opam2 images](https://hub.docker.com/r/ocaml/opam2/)

  already support many flavors of operating systems and are

  graciously maintained for you. You probably should use those if the

  speed of routine CI builds isn't a priority for you.