The docker-compose config included in the repo, along with some supporting scripts should help bootstrap a development environment.

How to use

From a fresh clone, run:

$ ./setup.sh
...

The containers are created using the current user's uid and gid so be sure to run this as you (not root). This is critical to making files generated inside the containers have the correct ownership.

Develop

The provided docker-compose.yml is geared towards developing rust programs that may require native dependencies, allowing those deps to be explicitly stated (by the Dockerfile).

The compose config manages a data volume for the CARGO_HOME so you can install deps and tools as needed and they will be preserved from run to run.

If you need to wipe your container clean, use docker-compose down --volumes then re-run ./setup.sh to rebuild your image.

Your development will happen inside the container, and as such you may like to use the ./run.sh script as a shorthand way to execute commands. For example:

$ ./run.sh cargo check
...

For running blocking commands that do funny stuff to the signal handling (like watchexec when run inside the docker container) there is another helper script called ./watch.sh which does some extra work to ensure you can kill the command with SIGTERM as you'd hope. For example:

$ ./run.sh cargo install watchexec
...

$ ./watch.sh watchexec cargo test
    Finished dev [unoptimized + debuginfo] target(s) in 0.0 secs
     Running target/debug/deps/my_binary-068139cf154b28dd

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

^C
$

A regrettable side-effect of how ./watch.sh works is it'll strip any color information out of the command output. Sorry! Hopefully there's a better solution out there for this and we'll find it eventually.

The build in the dev image is dynamicly linked and as such, native deps can be installed via apt-get.

Deploy

A deploy Dockerfile is included, which does a multi-phase (requiring docker 17.05 or above) cross build, which should ultimately yield a FROM scratch image with a static build of your app.

Example:

$ docker build -t my-app -f dockerfiles/builder/Dockerfile .
$ docker run --rm  my-app
Hello, world!
$

Since this Dockerfile is producing a static binary, your native dependecies may need to be built from source so that they can be statically linked.