display dynamic git version on homepage and openapi docs

Author: PierreBesson

.gitlab-ci.yml

@@ -84,6 +84,7 @@ build-push-image:
     - !reference [.image_version, script]
     - test "$DOCKER_USER" -a "$DOCKER_PASS" ||
         ( echo "no docker credentials provided"; exit 1 )
+    - echo "__version == '$(git describe --tags)'" > app/__init__.py
     - $BUILDAH_COMMAND build
         --format=docker
         --build-arg VCS_REF="${CI_COMMIT_SHA}"

app/__init__.py

@@ -0,0 +1,2 @@
+# This will be replaced at build time by `git describe --tags`
+__version__ = "UNDEFINED"

app/routers/views.py

@@ -2,6 +2,7 @@
 from starlette.responses import HTMLResponse
 from starlette.templating import Jinja2Templates
 
+from app import __version__
 from app.config.network_configuration import get_node_logs_link, get_network
 from app.lib.kubernetes_client import list_validator_stateful_sets, list_parachain_collator_stateful_sets
 from app.lib.network_utils import list_substrate_nodes, list_validators, get_session_queued_keys, list_parachains, \
@@ -18,7 +19,7 @@
 @router.get("/",  response_class=HTMLResponse, include_in_schema=False)
 @router.get("/index.html",  response_class=HTMLResponse, include_in_schema=False)
 async def homepage(request: Request):
-    return templates.TemplateResponse('index.html', {'request': request, 'network': network})
+    return templates.TemplateResponse('index.html', {'request': request, 'network': network, 'version': __version__})
 
 
 @router.get("/nodes", response_class=HTMLResponse, include_in_schema=False)

app/templates/index.html

@@ -15,4 +15,7 @@
         <a href="/docs">API Docs</a>
     </p>
 </body>
+<footer>
+    Version: {{ version }}
+</footer>
 </html>

main.py

@@ -5,6 +5,7 @@
 from fastapi.staticfiles import StaticFiles
 from starlette.responses import PlainTextResponse
 
+from app import __version__
 from app.routers import views, apis
 from app.config import log_config
 from app.config.settings import settings
@@ -16,7 +17,7 @@ class EndpointFilter(logging.Filter):
     def filter(self, record: logging.LogRecord) -> bool:
         return record.args and len(record.args) >= 3 and record.args[2] != "/health"
 
-app = FastAPI(title=settings.APP_NAME)
+app = FastAPI(title=settings.APP_NAME, version=__version__)
 app.include_router(apis.router)
 app.include_router(views.router)
 app.mount("/static", StaticFiles(directory="app/static"), name="static")

task-scheduler.py

@@ -5,6 +5,7 @@
 from fastapi.staticfiles import StaticFiles
 from starlette.responses import PlainTextResponse
 
+from app import __version__
 from app.lib.cron_tasks import load_cron_tasks
 from app.tasks import views, apis
 from app.config import log_config
@@ -18,7 +19,7 @@ def filter(self, record: logging.LogRecord) -> bool:
         return record.args and len(record.args) >= 3 and record.args[2] != "/health"
 
 
-app = FastAPI(title=settings.SCHEDULER_APP_NAME, on_startup=[load_cron_tasks])
+app = FastAPI(title=settings.SCHEDULER_APP_NAME, on_startup=[load_cron_tasks], version=__version__)
 app.include_router(apis.router)
 app.include_router(views.router)
 app.mount("/static", StaticFiles(directory="app/static"), name="static")