Merge branch 'tosate-feat/add-version-info' into develop

Author: nanomad

.github/workflows/build_python_mqtt_dev_images.yml

@@ -52,6 +52,8 @@ jobs:
         if: env.DOCKERHUB_ORGANIZATION == null
         with:
           context: .
+          build-args: |
+            RELEASE_VERSION=${{ env.RELEASE_VERSION }}
           platforms: linux/amd64,linux/arm64,linux/arm/v7
           push: true
           cache-from: type=gha
@@ -65,6 +67,8 @@ jobs:
         if: env.DOCKERHUB_ORGANIZATION != null
         with:
           context: .
+          build-args: |
+            RELEASE_VERSION=${{ env.RELEASE_VERSION }}
           platforms: linux/amd64,linux/arm64,linux/arm/v7
           push: true
           cache-from: type=gha

.github/workflows/build_python_mqtt_images.yml

@@ -52,6 +52,8 @@ jobs:
         if: env.DOCKERHUB_ORGANIZATION == null
         with:
           context: .
+          build-args: |
+            RELEASE_VERSION=${{ env.RELEASE_VERSION }}
           platforms: linux/amd64,linux/arm64,linux/arm/v7
           push: true
           tags: |
@@ -63,6 +65,8 @@ jobs:
         if: env.DOCKERHUB_ORGANIZATION != null
         with:
           context: .
+          build-args: |
+            RELEASE_VERSION=${{ env.RELEASE_VERSION }}
           platforms: linux/amd64,linux/arm64,linux/arm/v7
           push: true
           tags: |

Dockerfile

@@ -18,8 +18,14 @@ RUN poetry install --no-root && rm -rf $POETRY_CACHE_DIR
 #   We'll just copy the env and the PATH reference.
 FROM python:${PYTHON_VERSION}-slim AS runtime
 
+ARG RELEASE_VERSION=latest
+
+LABEL saic.mqtt.gateway.version="${RELEASE_VERSION}"
+LABEL saic.mqtt.gateway.description="SAIC MQTT Gateway: A Python-based service that queries the SAIC API, processes the data, and publishes it to an MQTT broker."
+
 WORKDIR /usr/src/app
 
+ENV RELEASE_VERSION=${RELEASE_VERSION}
 ENV VIRTUAL_ENV=/usr/src/app/.venv
 ENV PATH="/usr/src/app/.venv/bin:$PATH"
 

src/main.py

@@ -2,6 +2,8 @@
 
 import asyncio
 import faulthandler
+import logging
+import os
 import signal
 import sys
 
@@ -13,6 +15,10 @@
     from log_config import debug_log_enabled, setup_logging
 
     setup_logging()
+    log = logging.getLogger(__name__)
+    log.info(
+        f"Starting SAIC MQTT Gateway version {os.environ.get('RELEASE_VERSION', 'unknown')}"
+    )
 
     # Enable fault handler to get a thread dump on SIGQUIT
     faulthandler.enable(file=sys.stderr, all_threads=True)