feat(web): add version info display

Author: MickaelCa

.github/workflows/docker-build.ecr.yml

@@ -47,6 +47,19 @@ jobs:
           echo "timestamp=$(date +%s)" >> $GITHUB_OUTPUT
           echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
 
+      - name: Determine version
+        id: version
+        run: |
+          if [[ "${{ github.ref_type }}" == "tag" ]]; then
+            # If we're on a tag, use the tag name as version
+            echo "version=${{ github.ref_name }}" >> $GITHUB_OUTPUT
+          else
+            # If we're not on a tag, use branch-commit-hash format
+            BRANCH_NAME="${{ github.ref_name }}"
+            COMMIT_HASH="${{ steps.vars.outputs.sha_short }}"
+            echo "version=${BRANCH_NAME}-${COMMIT_HASH}" >> $GITHUB_OUTPUT
+          fi
+
       - name: Login to Amazon ECR
         id: login-ecr
         uses: aws-actions/amazon-ecr-login@v2
@@ -78,5 +91,8 @@ jobs:
           push: ${{ github.event_name != 'pull_request' || env.PUSH_FROM_PR == 'true' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=${{ steps.version.outputs.version }}
+            REPOSITORY_URL=https://github.com/${{ github.repository }}
           cache-from: type=gha
           cache-to: type=gha,mode=max

.github/workflows/docker-build.ghcr.yml

@@ -51,6 +51,19 @@ jobs:
           echo "timestamp=$(date +%s)" >> $GITHUB_OUTPUT
           echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
 
+      - name: Determine version
+        id: version
+        run: |
+          if [[ "${{ github.ref_type }}" == "tag" ]]; then
+            # If we're on a tag, use the tag name as version
+            echo "version=${{ github.ref_name }}" >> $GITHUB_OUTPUT
+          else
+            # If we're not on a tag, use branch-commit-hash format
+            BRANCH_NAME="${{ github.ref_name }}"
+            COMMIT_HASH="${{ steps.vars.outputs.sha_short }}"
+            echo "version=${BRANCH_NAME}-${COMMIT_HASH}" >> $GITHUB_OUTPUT
+          fi
+
       - name: Log in to the Container registry
         uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
         with:
@@ -87,6 +100,9 @@ jobs:
           push: ${{ github.event_name != 'pull_request' || env.PUSH_FROM_PR == 'true' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=${{ steps.version.outputs.version }}
+            REPOSITORY_URL=https://github.com/${{ github.repository }}
           cache-from: type=gha
           cache-to: type=gha,mode=max
 

Dockerfile

@@ -20,9 +20,13 @@ FROM python:3.13.5-slim@sha256:4c2cf9917bd1cbacc5e9b07320025bdb7cdf2df7b0ceaccb5
 
 ARG UID=1000
 ARG GID=1000
+ARG VERSION=unknown
+ARG REPOSITORY_URL=https://github.com/coderamp-labs/gitingest
 
 ENV PYTHONUNBUFFERED=1 \
-    PYTHONDONTWRITEBYTECODE=1
+    PYTHONDONTWRITEBYTECODE=1 \
+    VERSION=${VERSION} \
+    REPOSITORY_URL=${REPOSITORY_URL}
 
 RUN set -eux; \
     apt-get update; \

src/server/main.py

@@ -18,7 +18,7 @@
 from gitingest.utils.logging_config import get_logger
 from server.metrics_server import start_metrics_server
 from server.routers import dynamic, index, ingest
-from server.server_config import templates
+from server.server_config import get_version_info, templates
 from server.server_utils import limiter, rate_limit_exception_handler
 
 # Load environment variables from .env file
@@ -169,7 +169,9 @@ async def custom_swagger_ui(request: Request) -> HTMLResponse:
     - **HTMLResponse**: Custom Swagger UI documentation page
 
     """
-    return templates.TemplateResponse("swagger_ui.jinja", {"request": request})
+    context = {"request": request}
+    context.update(get_version_info())
+    return templates.TemplateResponse("swagger_ui.jinja", context)
 
 
 @app.get("/api", include_in_schema=True)

src/server/routers/dynamic.py

@@ -3,7 +3,7 @@
 from fastapi import APIRouter, Request
 from fastapi.responses import HTMLResponse
 
-from server.server_config import templates
+from server.server_config import get_version_info, templates
 
 router = APIRouter()
 
@@ -29,11 +29,11 @@ async def catch_all(request: Request, full_path: str) -> HTMLResponse:
         and other default parameters such as file size.
 
     """
-    return templates.TemplateResponse(
-        "git.jinja",
-        {
-            "request": request,
-            "repo_url": full_path,
-            "default_max_file_size": 243,
-        },
-    )
+    context = {
+        "request": request,
+        "repo_url": full_path,
+        "default_max_file_size": 243,
+    }
+    context.update(get_version_info())
+
+    return templates.TemplateResponse("git.jinja", context)

src/server/routers/index.py

@@ -3,7 +3,7 @@
 from fastapi import APIRouter, Request
 from fastapi.responses import HTMLResponse
 
-from server.server_config import EXAMPLE_REPOS, templates
+from server.server_config import EXAMPLE_REPOS, get_version_info, templates
 
 router = APIRouter()
 
@@ -27,11 +27,11 @@ async def home(request: Request) -> HTMLResponse:
         and other default parameters such as file size.
 
     """
-    return templates.TemplateResponse(
-        "index.jinja",
-        {
-            "request": request,
-            "examples": EXAMPLE_REPOS,
-            "default_max_file_size": 243,
-        },
-    )
+    context = {
+        "request": request,
+        "examples": EXAMPLE_REPOS,
+        "default_max_file_size": 243,
+    }
+    context.update(get_version_info())
+
+    return templates.TemplateResponse("index.jinja", context)

src/server/server_config.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import os
 from pathlib import Path
 
 from fastapi.templating import Jinja2Templates
@@ -21,6 +22,50 @@
 ]
 
 
+# Version and repository configuration
+VERSION = os.getenv("VERSION", "unknown")
+REPOSITORY_URL = os.getenv("REPOSITORY_URL", "https://github.com/coderamp-labs/gitingest")
+
+# Minimum number of parts expected in branch-commit format (e.g., "main-abc1234")
+MIN_BRANCH_COMMIT_PARTS = 2
+
+
+def get_version_info() -> dict[str, str]:
+    """Get version information including display version and link.
+
+    Returns
+    -------
+    dict[str, str]
+        Dictionary containing 'version' and 'version_link' keys.
+
+    """
+    version = VERSION
+    repo_url = REPOSITORY_URL.rstrip("/")
+
+    # Check if version looks like a tag (doesn't contain branch-commit pattern)
+    if version != "unknown" and "-" in version and len(version.split("-")) >= MIN_BRANCH_COMMIT_PARTS:
+        # This looks like branch-commit format (e.g., "main-abc1234")
+        parts = version.split("-")
+        if len(parts) >= MIN_BRANCH_COMMIT_PARTS:
+            # Take the last part as commit hash
+            commit_hash = parts[-1]
+            version_link = f"{repo_url}/commit/{commit_hash}"
+        else:
+            # Fallback to main branch
+            version_link = f"{repo_url}/tree/main"
+    elif version != "unknown":
+        # This looks like a tag version
+        version_link = f"{repo_url}/releases/tag/{version}"
+    else:
+        # Unknown version, link to main branch
+        version_link = f"{repo_url}/tree/main"
+
+    return {
+        "version": version,
+        "version_link": version_link,
+    }
+
+
 # Use absolute path to templates directory
 templates_dir = Path(__file__).parent / "templates"
 templates = Jinja2Templates(directory=templates_dir)

src/server/templates/components/footer.jinja

@@ -18,5 +18,13 @@
                                 'Discord') }}
             </div>
         </div>
+        {# Version information row #}
+        <div class="mt-2 text-center text-xs text-gray-600">
+            <span>Version:</span>
+            <a href="{{ version_link }}"
+               target="_blank"
+               rel="noopener noreferrer"
+               class="text-blue-600 hover:text-blue-800 underline">{{ version }}</a>
+        </div>
     </div>
 </footer>