diff --git a/bazel/README.md b/bazel/README.md index be10e9bab7..d7bfec504c 100644 --- a/bazel/README.md +++ b/bazel/README.md @@ -24,7 +24,7 @@ Dockers [Alpine, Archlinux, Centos, Debian, Fedora, OpenSuse, Ubuntu]: [![Status Compilation | Testing | Integration | -CI | +CI | OR-Tools comes with a Bazel based build ([WORKSPACE](../WORKSPACE)) that can be diff --git a/bazel/doc/ci.md b/bazel/docs/ci.md similarity index 56% rename from bazel/doc/ci.md rename to bazel/docs/ci.md index 92024ac435..91ed84aeca 100644 --- a/bazel/doc/ci.md +++ b/bazel/docs/ci.md @@ -1,20 +1,19 @@ # CI: Makefile/Docker testing + 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 VM images (e.g. [github actions/virtual-environments](https://github.com/actions/virtual-environments)). +* You can run it locally on any host having a linux docker image support. +* Most CI provide runner with docker and Makefile installed. cons: * Only GNU/Linux distro supported. * Could take few GiB (~30 GiB for all distro and all languages) * ~500MiB OS + C++/CMake tools, - * ~150 MiB Python, - * ~400 MiB dotnet-sdk, - * ~400 MiB java-jdk. -# Usage +## Usage + To get the help simply type: ```sh make @@ -25,13 +24,14 @@ note: you can also use from top directory make --directory=bazel ``` -## Example +### Example For example to test inside an `Ubuntu` container: ```sh make ubuntu_test ``` -# Docker Layers +## Docker Layers + Dockerfile is splitted in several stages. ![docker](docker.svg) diff --git a/bazel/doc/docker.dot b/bazel/docs/docker.dot similarity index 100% rename from bazel/doc/docker.dot rename to bazel/docs/docker.dot diff --git a/bazel/doc/docker.svg b/bazel/docs/docker.svg similarity index 100% rename from bazel/doc/docker.svg rename to bazel/docs/docker.svg diff --git a/bazel/doc/generate_image.sh b/bazel/docs/generate_image.sh similarity index 58% rename from bazel/doc/generate_image.sh rename to bazel/docs/generate_image.sh index cd1743a7f1..45b39f1b53 100755 --- a/bazel/doc/generate_image.sh +++ b/bazel/docs/generate_image.sh @@ -1,7 +1,7 @@ -#/usr/bin/env bash -set -ex +#!/usr/bin/env bash +set -eux -rm -f *.svg *.png +rm -f ./*.svg ./*.png for i in *.dot; do #plantuml -Tpng "$i"; plantuml -Tsvg "$i"; diff --git a/cmake/README.md b/cmake/README.md index d014bb89d0..b5b54d8a50 100644 --- a/cmake/README.md +++ b/cmake/README.md @@ -42,13 +42,13 @@ Dockers [Alpine, Archlinux, Centos, Debian, Fedora, OpenSuse, Ubuntu]x[C++, Pyth OR-Tools comes with a CMake based build ([CMakeLists.txt](../CMakeLists.txt)) diff --git a/cmake/doc/ci.md b/cmake/docs/ci.md similarity index 100% rename from cmake/doc/ci.md rename to cmake/docs/ci.md diff --git a/cmake/doc/cmake.dot b/cmake/docs/cmake.dot similarity index 100% rename from cmake/doc/cmake.dot rename to cmake/docs/cmake.dot diff --git a/cmake/doc/cmake.svg b/cmake/docs/cmake.svg similarity index 100% rename from cmake/doc/cmake.svg rename to cmake/docs/cmake.svg diff --git a/cmake/doc/cpp.md b/cmake/docs/cpp.md similarity index 100% rename from cmake/doc/cpp.md rename to cmake/docs/cpp.md diff --git a/cmake/doc/deps.dot b/cmake/docs/deps.dot similarity index 100% rename from cmake/doc/deps.dot rename to cmake/docs/deps.dot diff --git a/cmake/doc/deps.svg b/cmake/docs/deps.svg similarity index 100% rename from cmake/doc/deps.svg rename to cmake/docs/deps.svg diff --git a/cmake/doc/docker.dot b/cmake/docs/docker.dot similarity index 100% rename from cmake/doc/docker.dot rename to cmake/docs/docker.dot diff --git a/cmake/doc/docker.svg b/cmake/docs/docker.svg similarity index 100% rename from cmake/doc/docker.svg rename to cmake/docs/docker.svg diff --git a/cmake/doc/dotnet.md b/cmake/docs/dotnet.md similarity index 100% rename from cmake/doc/dotnet.md rename to cmake/docs/dotnet.md diff --git a/cmake/doc/generate_image.sh b/cmake/docs/generate_image.sh similarity index 100% rename from cmake/doc/generate_image.sh rename to cmake/docs/generate_image.sh diff --git a/cmake/doc/java.md b/cmake/docs/java.md similarity index 100% rename from cmake/doc/java.md rename to cmake/docs/java.md diff --git a/cmake/doc/python.md b/cmake/docs/python.md similarity index 100% rename from cmake/doc/python.md rename to cmake/docs/python.md diff --git a/cmake/doc/swig.md b/cmake/docs/swig.md similarity index 100% rename from cmake/doc/swig.md rename to cmake/docs/swig.md diff --git a/makefiles/README.md b/makefiles/README.md index 8bda4577c2..a5a60ee4b3 100644 --- a/makefiles/README.md +++ b/makefiles/README.md @@ -41,7 +41,7 @@ Python, Java, .Net]: [![Status][docker_svg]][docker_link] ## Introduction OR-Tools comes with a GNU Make based build ([Makefile](../Makefile)) that can be diff --git a/makefiles/doc/ci.md b/makefiles/docs/ci.md similarity index 100% rename from makefiles/doc/ci.md rename to makefiles/docs/ci.md diff --git a/makefiles/doc/deps.dot b/makefiles/docs/deps.dot similarity index 100% rename from makefiles/doc/deps.dot rename to makefiles/docs/deps.dot diff --git a/makefiles/doc/deps.svg b/makefiles/docs/deps.svg similarity index 100% rename from makefiles/doc/deps.svg rename to makefiles/docs/deps.svg diff --git a/makefiles/doc/docker.dot b/makefiles/docs/docker.dot similarity index 100% rename from makefiles/doc/docker.dot rename to makefiles/docs/docker.dot diff --git a/makefiles/doc/docker.svg b/makefiles/docs/docker.svg similarity index 100% rename from makefiles/doc/docker.svg rename to makefiles/docs/docker.svg diff --git a/makefiles/doc/generate_image.sh b/makefiles/docs/generate_image.sh similarity index 100% rename from makefiles/doc/generate_image.sh rename to makefiles/docs/generate_image.sh diff --git a/makefiles/doc/make.dot b/makefiles/docs/make.dot similarity index 100% rename from makefiles/doc/make.dot rename to makefiles/docs/make.dot diff --git a/makefiles/doc/make.svg b/makefiles/docs/make.svg similarity index 100% rename from makefiles/doc/make.svg rename to makefiles/docs/make.svg