feat: optimize docker image (#960)

gdubicki · amimas · TimKnight01 · commit 29f24eef141a · 2026-02-16T12:12:51.000Z
* build: faster building and smaller image locally

(if you would ever do this) thanks to not adding to it
any files that are not really needed, but may exist on
a development machine

* build: ~10MB (~11%) smaller image (numbers for ARM64)

thanks to not creating pip cache (really)
and not installing seemingly unneeded APK packages

* build: we only need types packages for development

* style: re-arrange dev dependencies in alphabetical order

* fix: restore copy command so that docker build works

* feat: use multi-stage dockerfile to reduce image size

The change also updates dockerignore file ignoring more files from build context

---------

Co-authored-by: amimas &lt;aver.mimas@gmail.com&gt;
diff --git a/.dockerignore b/.dockerignore
@@ -1,12 +1,43 @@
-/.git
-/.github
-/.idea
-/.overrides
-/dev
-# only gitlabform directory is needed
-/docs
-/.gitlabform.egg-info
-/tests
-/venv
-.dockerignore
+# Git
+.git
 .gitignore
+.git-blame-ignore-revs
+
+# Docker
+.dockerignore
+Dockerfile
+
+# Python cache and artifacts
+*.pyc
+__pycache__/
+*.egg-info
+.mypy_cache/
+.pytest_cache/
+
+# Test, dev, and local environments
+tests/
+dev/
+venv/
+.venv/
+
+# Documentation
+docs/
+.overrides/
+mkdocs.yml
+*.txt
+*.md
+
+# CI/CD and project config
+.github/
+.pre-commit-config.yaml
+.coveragerc
+codecov.yml
+.lgtm.yml
+.mypy.ini
+coverage.xml
+tbump.toml
+
+# Editor/IDE config
+.idea/
+.vscode/
+.cursor/
diff --git a/Dockerfile b/Dockerfile
@@ -1,17 +1,35 @@
-FROM python:3.12-alpine
-RUN apk add --no-cache \
-    gmp \
-    lua5.3 \
-    lua5.3-lpeg
-RUN mkdir gitlabform
-COPY . /gitlabform
-
-RUN cd gitlabform \
-    && apk add --no-cache build-base \
-    && pip install -e . \
-    && apk --purge del build-base
+# ---- Builder Stage ----
+FROM python:3.12-alpine AS builder
 
-WORKDIR /config
+# Set the working directory
+WORKDIR /app
+
+# Install build-time dependencies
+RUN apk add --no-cache build-base
+
+# Copy dependency definitions to leverage Docker's layer cache
+COPY pyproject.toml ./
+
+# Install dependencies. This layer will be cached as long as pyproject.toml does not change.
+RUN pip install --no-cache-dir --prefix=/install .
+
+# Now copy the application source code and install the application itself
+COPY gitlabform ./gitlabform
+# Install the application code itself. Dependencies are already in the cached layer above,
+# so we use --no-deps to make it faster and the intent clear.
+RUN pip install --no-deps --no-cache-dir --prefix=/install .
 
+# ---- Final Stage ----
+FROM python:3.12-alpine AS final
+
+# Create a non-root user for security
 RUN addgroup -S appgroup && adduser -S appuser -G appgroup
+
+# Copy the installed artifacts from the builder stage
+COPY --from=builder /install /usr/local
+
+# Set the user to the non-root user
 USER appuser
+
+# Set the working directory for the application to run
+WORKDIR /config
diff --git a/pyproject.toml b/pyproject.toml
@@ -36,8 +36,6 @@ dependencies = [
     "python-gitlab[graphql]==7.1.0",
     "requests==2.32.5",
     "ruamel.yaml==0.17.21",
-    "types-requests==2.32.4.20260107",
-    "types-setuptools==81.0.0.20260209",
     "yamlpath==3.8.2",
 ]
 
@@ -62,6 +60,8 @@ test = [
     "pytest==9.0.2",
     "pytest-cov==7.0.0",
     "pytest-rerunfailures==16.1",
+    "types-requests==2.32.4.20260107",
+    "types-setuptools==81.0.0.20260209",
     "xkcdpass==1.30.0",
 ]
 docs = ["mkdocs", "mkdocs-material"]
