feat: add app version footer with deployment tracking

dragonee · claude · dragonee · commit 9e2b524a631f · 2025-10-18T12:21:37.000+02:00
Add automatic version tracking via REVISION file generated during deployment. Display version in a fixed footer on all pages except the tasks app. Changes: - Generate REVISION file in deploy workflow with format: version-revision - Add app_version context processor to read and cache REVISION file - Add footer to base.html that shows when APP_VERSION is available - Style footer as fixed bottom-right element with subtle appearance - Hide footer on tasks app page (body_class: app-tasks) - Add REVISION to .gitignore to exclude from version control The version footer only appears in production where the REVISION file exists, and remains hidden during local development. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -16,7 +16,9 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - uses: actions/setup-python@v4
         with:
           python-version: '3.10'
@@ -48,6 +50,11 @@ jobs:
         run: npm run build-dist
       - name: Copy static assets
         run: python3 manage.dist.py collectstatic --noinput
+      - name: Generate REVISION file
+        run: |
+          git fetch --tags
+          git describe --tags > tasks/REVISION
+          echo "Generated version: $(cat tasks/REVISION)"
       - name: Copy files to the server
         uses: burnett01/rsync-deployments@5.2
         with:
diff --git a/.gitignore b/.gitignore
@@ -343,4 +343,5 @@ pbtasks-*.sql
 
 # End of https://www.gitignore.io/api/vim,node,linux,macos,django,python,windows,notepadpp,sublimetext
 
-.pyscn/
+.pyscn/
+REVISION
diff --git a/tasks/apps/tree/context_processors.py b/tasks/apps/tree/context_processors.py
@@ -1,6 +1,35 @@
 from datetime import datetime
+from pathlib import Path
+from django.conf import settings
+
+# Cache for APP_VERSION
+_app_version_cache = {'loaded': False, 'version': None}
 
 def menu(request):
     return {
         'current_year': datetime.now().year
-    }
+    }
+
+def app_version(request):
+    """Context processor to provide APP_VERSION from REVISION file.
+
+    Reads the REVISION file (created during deployment) and caches it in memory.
+    Returns None if the file doesn't exist (e.g., in development).
+    """
+    global _app_version_cache
+
+    # Return cached value if already loaded
+    if _app_version_cache['loaded']:
+        return {'APP_VERSION': _app_version_cache['version']}
+
+    # Try to read REVISION file
+    revision_file = Path(settings.BASE_DIR) / 'REVISION'
+
+    if revision_file.exists():
+        try:
+            _app_version_cache['version'] = revision_file.read_text().strip()
+        except (OSError, IOError):
+            pass
+
+    _app_version_cache['loaded'] = True
+    return {'APP_VERSION': _app_version_cache['version']}
diff --git a/tasks/assets/styles/example.scss b/tasks/assets/styles/example.scss
@@ -1857,4 +1857,24 @@ $calendar-color: rgba(223, 9, 9, 0.7);
     background-color: #f8d7da;
     border-color: #f5c6cb;
     color: #721c24;
+}
+
+.app-version-footer {
+    position: fixed;
+    bottom: 10px;
+    right: 10px;
+    padding: 4px 8px;
+    background-color: rgba(0, 0, 0, 0.05);
+    border-radius: 3px;
+    font-size: 0.75rem;
+    color: #999;
+    z-index: 100;
+
+    .app-version {
+        font-family: monospace;
+    }
+
+    .app-tasks & {
+        display: none;
+    }
 }
diff --git a/tasks/settings/base.py b/tasks/settings/base.py
@@ -82,6 +82,7 @@
                 'django.contrib.auth.context_processors.auth',
                 'django.contrib.messages.context_processors.messages',
                 'tasks.apps.tree.context_processors.menu',
+                'tasks.apps.tree.context_processors.app_version',
             ],
         },
     },
diff --git a/tasks/templates/base.html b/tasks/templates/base.html
@@ -28,6 +28,12 @@
     <body class="{% block body_class %}{% endblock %}">
         {% block content %} {% endblock %}
 
+        {% if APP_VERSION %}
+        <footer class="app-version-footer">
+            <span class="app-version">{{ APP_VERSION }}</span>
+        </footer>
+        {% endif %}
+
         {% block jsmount %}
             {% render_js 'app' %}
         {% endblock %}
diff --git a/tasks/templates/tree/tasks.html b/tasks/templates/tree/tasks.html
@@ -3,6 +3,8 @@
 
 {% block title %}Tasks | Tasks Collector{% endblock %}
 
+{% block body_class %}app-tasks{% endblock %}
+
 {% block content %}
 <!-- Vue entry-point -->
 
