From 2a80c2e11500cd829d16fcc754eae1c1d9bbf248 Mon Sep 17 00:00:00 2001 From: Corentin Le Molgat Date: Fri, 25 Feb 2022 08:05:16 +0100 Subject: [PATCH] fixup doc --- makefiles/docs/ci.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/makefiles/docs/ci.md b/makefiles/docs/ci.md index fa1f833a61..ebdaed9b91 100644 --- a/makefiles/docs/ci.md +++ b/makefiles/docs/ci.md @@ -1,12 +1,18 @@ # CI: Makefile/Docker testing -To test the build on various distro, I'm using docker containers and a Makefile for orchestration. + +To test the build on various distro, I'm using docker containers and a Makefile +for orchestration. pros: -* You are independent of third party CI runner config (e.g. github actions runners or Travis-CI VM images). -* You can run it locally on your linux system. -* Most CI provide runner with docker and Makefile installed (e.g. tarvis-ci [minimal images](https://docs.travis-ci.com/user/languages/minimal-and-generic/). + +* You are independent of third party CI runner config (e.g. github actions + runners or Travis-CI VM images). +* You can run it locally on your linux system. +* Most CI provide runner with docker and Makefile installed (e.g. tarvis-ci + [minimal images](https://docs.travis-ci.com/user/languages/minimal-and-generic/). cons: + * Only GNU/Linux distro supported. * Could take few GiB (~30 GiB for all distro and all languages) * ~500MiB OS + C++/CMake tools, @@ -14,7 +20,7 @@ cons: * ~400 MiB dotnet-sdk, * ~400 MiB java-jdk. -# Usage +## Usage To get the help simply type: ```sh make @@ -25,13 +31,13 @@ note: you can also use from top directory make --directory=makefiles ``` -## Example +### Example For example to test `Python` inside an `Alpine` container: ```sh make alpine_python_test ``` -# Docker layers -Dockerfile is splitted in several stages. +## Docker layers +Dockerfile is split in several stages. ![docker](docker.svg)