A composable build system for OCaml
OCaml Perl PHP Shell Perl 6 Makefile Other
Clone or download
Latest commit 4bd1bcb Jul 21, 2018
Permalink
Failed to load latest commit information.
bin Plumb through env node Jul 18, 2018
doc Update documentation for executable stanza format Jul 13, 2018
example Get rid of indexed lookups for deps Jul 6, 2018
pkg Convert a few files to markdown Jun 2, 2017
plugin Forbid #require in dune files in OCaml syntax (#938) Jul 2, 2018
src Update latest syntax to 1.1 Jul 21, 2018
test Update latest syntax to 1.1 Jul 21, 2018
vendor Do not use opam-installer to copy files (#941) Jul 3, 2018
.gitignore Allow to set the library path at configure time (#575) Mar 6, 2018
.ocp-indent Add a .ocp-indent file Mar 4, 2017
.travis-ci.sh Remove jbuilder files Jul 12, 2018
.travis.yml Add 4.07.0 support in travis Jul 15, 2018
CHANGES.md Update changelog for 1.0.1 Jul 19, 2018
CONTRIBUTING.md Fix typos in source code Jul 10, 2018
HACKING.md Move hacking to its own page Mar 20, 2018
LICENSE.md Switch to MIT License May 23, 2018
MIGRATION.md Refer to migration page from manual and readme Jun 25, 2018
Makefile Make the default build profile be dev Jun 28, 2018
README.md Fix #995 Jul 11, 2018
appveyor.yml Make the default build profile be dev Jun 28, 2018
bootstrap.ml Make it work during bootstrap Jul 17, 2018
configure Allow to set the library path at configure time (#575) Mar 6, 2018
configure.ml Allow to set the library path at configure time (#575) Mar 6, 2018
dune-project Set dune language version to 1.0 (#873) Jun 11, 2018
dune-workspace.dev Update workspace file for 4.07.0 Jul 15, 2018
dune.descr Update dune.descr Jul 10, 2018
dune.opam Make the default build profile be dev Jun 28, 2018
install_ocaml.cmd Update AppVeyor to OCaml 4.06.0 Nov 15, 2017

README.md

Dune - A composable build system

Dune is a build system designed for OCaml/Reason projects only. It focuses on providing the user with a consistent experience and takes care of most of the low-level details of OCaml compilation. All you have to do is provide a description of your project and dune will do the rest.

The scheme it implements is inspired from the one used inside Jane Street and adapted to the open source world. It has matured over a long time and is used daily by hundreds of developers, which means that it is highly tested and productive.

Dune comes with a manual. If you want to get started without reading too much, you can look at the quick start guide or watch this introduction video.

The example directory contains examples of projects using dune.

Travis status AppVeyor status

Overview

Dune reads project metadata from dune files, which are either static files in a simple S-expression syntax or OCaml scripts. It uses this information to setup build rules, generate configuration files for development tools such as merlin, handle installation, etc...

Dune itself is fast, has very low overhead and supports parallel builds on all platforms. It has no system dependencies: all you need to build dune and packages using dune is OCaml. You don't need make or bash as long as the packages themselves don't use bash explicitly.

Especially, one can install OCaml on Windows with a binary installer and then use only the Windows Console to build dune and packages using dune.

Strengths

Composable

Take n repositories that use dune, arrange them in any way on the file system and the result is still a single repository that dune knows how to build at once.

This make simultaneous development on multiple packages trivial.

Gracefully handles multi-package repositories

Dune knows how to handle repositories containing several packages. When building via opam, it is able to correctly use libraries that were previously installed even if they are already present in the source tree.

The magic invocation is:

$ dune build --only-packages <package-name> @install

Building against several configurations at once

Dune is able to build a given source code repository against several configurations simultaneously. This helps maintaining packages across several versions of OCaml as you can test them all at once without hassle.

This feature should make cross-compilation easy, see details in the roadmap.

This feature requires opam.

Jenga bridge

Jenga is another build system for OCaml that has more advanced features such as polling or much better editor integration. Jenga is more powerful and more complex and as a result has many more dependencies. It is planned to implement a small bridge between the two so that a dune project can build with Jenga using this bridge.

Requirements

Dune requires OCaml version 4.02.3 or greater.

Installation

The recommended way to install dune is via the opam package manager:

$ opam install dune

You can also build it manually with:

$ make release
$ make install

Note however that make install requires the opam-installer tool. Running simply make will build dune using the development settings.

If you do not have make, you can do the following:

$ ocaml bootstrap.ml
$ ./boot.exe
$ ./_build/default/bin/main_dune.exe install

Support

If you have questions about dune, you can send an email to ocaml-core@googlegroups.com or open a ticket on github.

Migration from jbuilder

Dune was formerly known as jbuilder. Migration from jbuilder to dune is described in the manual.

Status

Dune is now fairly stable and is used by the majority of packages on opam. The package is still in beta version as we are waiting for the renaming from Jbuilder to dune before releasing version 1.0.0. Note that dune will have backward compatibility with Jbuilder, in particular existing Jbuilder projects will continue to be buildable with dune.