README.md

rustfmt-clippy

Builds a Rust environment Docker image to get an easy-to-use working code formatting and linting set-up for CI/CD, executable for any user.

Periodically run by CI to automatically push valid Docker images into the Docker registry. This builds for all three toolchains, stable, beta and nightly.

Note that the underlying distribution is currently Debian based.

How to use

The designated directory for the Rust project directory is /volume.

Assuming your current pwd is at the desired Rust project directory to build:

docker run --rm -it -v `pwd`:/volume -u `id -u`:`id -g` guangie88/rustfmt-clippy:stable cargo fmt
docker run --rm -it -v `pwd`:/volume -u `id -u`:`id -g` guangie88/rustfmt-clippy:stable cargo clippy
docker run --rm -it -v `pwd`:/volume -u `id -u`:`id -g` guangie88/rustfmt-clippy:stable cargo build

The above runs various cargo subcommands as your current host user, and saves the Cargo cache within .cargo in your Rust project directory. You should put .cargo into your .gitignore if you are planning to frequently use this Docker image for your development.

Executables included

• cargo and rustc
• rustfmt (i.e. cargo fmt)
• clippy (i.e. cargo clippy)

Development libraries included

• default-libmysqlclient-dev
• libpq-dev
• libsqlite3-dev
• libssl-dev
• libcurl4-openssl-dev
• zlib1g-dev

Scripts executed by CI

docker build \
    --build-arg RUST_CHANNEL=${RUST_CHANNEL} \
    -t guangie88/rustfmt-clippy:${RUST_CHANNEL} \
    .

The latest tag is deprecated since 6 July 2019, as such, it is recommended to use stable, which corresponds to the stable toolchain of rustup.

If nightly toolchain must be used, then it is recommended to pin to nightly-yyyy-mm-dd, where yyyy-mm-dd is the year/month/day nightly build date, since nightly builds are possibly unstable across different dates.

Acknowledgement

This repository is clearly inspired by: https://github.com/clux/muslrust, so thanks to the author.