Burn version into image

Author: medihack

Dockerfile

@@ -2,6 +2,8 @@
 
 FROM python:3.12-bullseye AS builder-base
 
+ARG PROJECT_VERSION
+
 # Install dependencies for the `psql` command.
 # Must match the version of the postgres service in the compose file!
 RUN apt-get update \
@@ -42,6 +44,7 @@ ADD . /app
 RUN --mount=type=cache,target=/root/.cache/uv \
   uv sync --frozen
 
+ENV PROJECT_VERSION=${PROJECT_VERSION}
 
 # production image
 FROM builder-base AS production
@@ -55,3 +58,5 @@ ADD . /app
 
 RUN --mount=type=cache,target=/root/.cache/uv \
   uv sync --frozen --no-dev
+
+ENV PROJECT_VERSION=${PROJECT_VERSION}

adit_radis_shared/cli_commands.py

@@ -72,17 +72,13 @@ def compose_up(
             "Check ENVIRONMENT setting in .env file."
         )
 
-    version = helpers.get_latest_local_version_tag()
-    if not helpers.is_production():
-        version += "-dev"
-
-    cmd = f"{helpers.build_compose_cmd(profile)} up"
-
-    if not build:
-        cmd += " --no-build"
+    if build:
+        cmd = f"{helpers.build_compose_cmd()} build"
+        cmd += f" --build-arg PROJECT_VERSION={helpers.get_project_version()}-cli"
+        helpers.execute_cmd(cmd)
 
-    cmd += " --detach"
-    helpers.execute_cmd(cmd, env={"PROJECT_VERSION": version})
+    cmd = f"{helpers.build_compose_cmd(profile)} up --no-build --detach"
+    helpers.execute_cmd(cmd)
 
 
 def compose_down(
@@ -104,27 +100,21 @@ def stack_deploy(build: Annotated[bool, typer.Option(help="Build images")] = Fal
 
     helpers.prepare_environment()
 
-    config = helpers.load_config_from_env_file()
-    if config.get("ENVIRONMENT") != "production":
+    if not helpers.is_production():
         sys.exit(
             "stack-deploy task can only be used in production environment. "
             "Check ENVIRONMENT setting in .env file."
         )
 
     if build:
         cmd = f"{helpers.build_compose_cmd()} build"
+        cmd += f" --build-arg PROJECT_VERSION={helpers.get_project_version()}-cli"
         helpers.execute_cmd(cmd)
 
-    version = helpers.get_latest_local_version_tag()
-    if not helpers.is_production():
-        version += "-dev"
-
     # Docker Swarm Mode does not support .env files so we load the .env file manually
     # and pass the content as an environment variables.
     env = helpers.load_config_from_env_file()
 
-    env["PROJECT_VERSION"] = version
-
     cmd = "docker stack deploy --detach "
     cmd += f" -c {helpers.get_compose_base_file()}"
     cmd += f" -c {helpers.get_compose_env_file()}"

adit_radis_shared/cli_helpers.py

@@ -20,6 +20,7 @@
 from cryptography.x509.oid import NameOID
 from django.core.management.utils import get_random_secret_key
 from dotenv import dotenv_values
+from dunamai import Pattern, Version
 
 PROJECT_ID: str | None = None
 ROOT_PATH: Path | None = None
@@ -210,17 +211,8 @@ def get_latest_remote_version_tag(owner, repo) -> str | None:
     return None
 
 
-def get_latest_local_version_tag() -> str:
-    # Get all tags sorted by creation date (newest first)
-    result = capture_cmd("git tag -l --sort=-creatordate")
-    all_tags = result.splitlines()
-
-    version_pattern = re.compile(r"^\d+\.\d+\.\d+$")
-    for tag in all_tags:
-        if version_pattern.match(tag):
-            return tag
-
-    return "0.0.0"
+def get_project_version() -> str:
+    return Version.from_git(pattern=Pattern.DefaultUnprefixed).serialize()
 
 
 def generate_django_secret_key():

docker-compose.base.yml

@@ -14,7 +14,6 @@ x-app: &default-app
     DJANGO_SECRET_KEY: ${DJANGO_SECRET_KEY:?}
     DJANGO_SERVER_EMAIL: ${DJANGO_SERVER_EMAIL:?}
     IS_DOCKER_CONTAINER: 1
-    PROJECT_VERSION: ${PROJECT_VERSION:-vX.Y.Z}
     SITE_DOMAIN: ${SITE_DOMAIN:?}
     SITE_NAME: ${SITE_NAME:?}
     SUPERUSER_AUTH_TOKEN: ${SUPERUSER_AUTH_TOKEN:-}

example_project/example_project/settings/base.py

@@ -25,8 +25,8 @@
 # The source paths of the project
 SOURCE_PATHS = [BASE_PATH / "adit_radis_shared", BASE_PATH / "example_project"]  # noqa: F405
 
-# Fetch version from the environment which is passed through from the latest git version tag
-PROJECT_VERSION = env.str("PROJECT_VERSION", default="vX.Y.Z")
+# Fetch version from the environment which is passed through from the git version tag
+PROJECT_VERSION = env.str("PROJECT_VERSION", default="0.0.0")
 
 # The project URL used in the navbar and footer
 PROJECT_URL = "https://github.com/openradx/adit-radis-shared"

pyproject.toml

@@ -22,10 +22,14 @@ dependencies = [
     "django-revproxy ~= 0.13",
     "django-tables2 ~= 2.7",
     "djangorestframework ~= 3.15",
+    "dunamai>=1.23.0",
     "environs[django] ~= 14.1",
     "procrastinate[django] ~= 3.0",
     "psycopg[binary] ~= 3.2",
+    "python-dotenv ~= 1.0",
+    "requests ~= 2.32",
     "Twisted[tls,http2] ~= 24.11",
+    "typer ~= 0.15",
     "wait-for-it ~= 2.3",
     "watchfiles ~= 1.0",
     "whitenoise ~= 6.9",
@@ -57,12 +61,9 @@ dev = [
     "pytest-playwright ~= 0.7",
     "pytest-timeout ~= 2.3",
     "pytest-watch ~= 4.2",
-    "python-dotenv ~= 1.0",
     "pywatchman ~= 2.0",
-    "requests ~= 2.32",
     "ruff ~= 0.9",
     "time-machine ~= 2.16",
-    "typer ~= 0.15",
     "vermin ~= 1.6",
 ]