ci: Build docs with docker

We're having odd errors in the travis python runner that I cannot reproduce locally.

Solution: Build docs with docker build. With the BuildKit backend it's quite easy to `--output` the site directory.

Author: christiansiegel

.dockerignore

@@ -1,10 +1,13 @@
 *
+!docs
 !gitopscli/
 !tests/
 !.pylintrc
+!CONTRIBUTING.md
+!mkdocs.yml
+!Makefile
 !mypy.ini
 !requirements-dev.txt
-!requirements.txt
 !setup.py
 
 **/__pycache__/

.travis.yml

@@ -5,6 +5,8 @@ language: shell
 env:
   global:
     - DOCKER_IMAGE: baloise/gitopscli
+    - DOCKER_BUILDKIT: '1' # use BuildKit backend (https://docs.docker.com/engine/reference/builder/#buildkit)
+    - BUILDKIT_PROGRESS: plain
     # DOCKER_USERNAME
     - secure: "Ecq9r+yXVc9gVdn1e4sDS/yegMKOyN3F6f4jxNSNl1pEkBZayVOvl6seh58sK+QzaIOLlrMYNlOzmWIKaekRuskYLJNYMUh67RJB24knOMSbA0hD3WPO8GbFY1Y/Xe1Gk5zKlLqFKe9OoCbM0ItGIXL2DrFPWl94F1YoZim2h7q6lFEo9NHvYSjreGMcqJujQKoN5/UkO76C3TEKNFXbyxev18nHwXQvqC2axbZONYEQuzYC7dDDAHRMxQ25t2qcWh19f/ssl0qR7VYheBY72Pypvl131+qIxaMl+r/7UeKHnhrM2/ineyo8VPfxhHwar31ldu0YyC0KtSYEMERASsKmJNyaP9d3mo6Vciws/8fGaU0FqlwfRPOhaa/ixMS43qJ4NS9vSogteQJVIIC4B9mHmFvzShDK5aDML+KJ0ehQnayS/30AywS80iSkSWdbkKPAdr+djVhUbey+LAWPVdmJOnIiBET4eSFqJ37dXmcKrhUcfrthL2SftkTGZ4Fm4gHPNYWXIej9N6kTwHlYzRkuJN3PNTLsqp9YE6dUYIUZEu0qkyX2IBljdOxLK5UTKzdkD+j8kLFEP2kN1ELbhP4qEBJj17swycTP9wR4RB+FfjsdeTXonaEOGq8z2CctnczJe87TJ1/GuRj5l/VXiK2ph25El/Axhg5Kv3lHxJw="
     # DOCKER_PASSWORD
@@ -17,12 +19,11 @@ jobs:
     - stage: test
       language: shell
       services: docker
-      script: docker build .
+      script: docker build --target=test .
     - stage: doc
-      language: python
-      python: 3.6
-      install: pip install -r requirements-dev.txt
-      script: mkdocs build
+      language: shell
+      services: docker
+      script: docker build --target=docs-site --output . .
       deploy:
         provider: pages
         strategy: git

Dockerfile

@@ -1,26 +1,52 @@
-FROM python:3.8-alpine AS base-image
+# =========
+FROM python:3.8-alpine AS base
 
 ENV PATH="/opt/venv/bin:$PATH"
 RUN apk add --no-cache git
 
-FROM base-image AS build-image
+# =========
+FROM base AS deps
 
-RUN apk add --no-cache gcc linux-headers musl-dev \
- && python -m venv /opt/venv \
- && pip install --upgrade pip
 WORKDIR /workdir
-COPY . .
+RUN apk add --no-cache gcc linux-headers musl-dev make
+RUN python -m venv /opt/venv
+RUN pip install --upgrade pip
+COPY setup.py .
 RUN pip install .
 
-FROM build-image AS test-image
+# =========
+FROM deps AS dev
 
+COPY requirements-dev.txt .
 RUN pip install -r requirements-dev.txt
-RUN black --check -l 120 -t py37 gitopscli tests setup.py
-RUN pylint gitopscli
-RUN mypy .
-RUN python -m pytest -vv -s --typeguard-packages=gitopscli
 
-FROM base-image AS runtime-image
+# =========
+FROM dev AS docs
+
+COPY docs ./docs
+COPY CONTRIBUTING.md mkdocs.yml ./
+RUN mkdocs build
+
+# =========
+FROM scratch AS docs-site
+
+COPY --from=docs /workdir/site /site
+
+# =========
+FROM dev AS test
+
+COPY . .
+RUN pip install .
+RUN make checks
+
+# =========
+FROM deps AS install
+
+COPY . .
+RUN pip install .
+
+# =========
+FROM base as final
 
-COPY --from=build-image /opt/venv /opt/venv
+COPY --from=install /opt/venv /opt/venv
 ENTRYPOINT ["gitopscli"]

Makefile

@@ -28,7 +28,7 @@ coverage:
 checks: format-check lint mypy test
 
 image:
-	docker build -t gitopscli:latest .
+	DOCKER_BUILDKIT=1 docker build -t gitopscli:latest .
 
 docs:
 	mkdocs serve