feat: expose the deployed version via the API and show it in the GUI

Author: chutch3

api/API/Controllers/Responses/VersionResponse.cs

@@ -0,0 +1,11 @@
+
+namespace API.Controllers.Responses;
+
+/// <summary>The running build's identity, stamped at compile time by GitInfo + BuildInformation.</summary>
+public record VersionResponse(string Version, string Commit, string BuiltAt)
+{
+    public static VersionResponse Current => new(
+        ThisAssembly.Git.Tag is { Length: > 0 } tag ? tag : $"{ThisAssembly.Git.Branch}@{ThisAssembly.Git.Commit}",
+        ThisAssembly.Git.Commit,
+        BuildInformation.BuildAt.ToString("u"));
+}

api/API/Controllers/VersionController.cs

@@ -0,0 +1,21 @@
+using API.Controllers.Responses;
+using Asp.Versioning;
+using Microsoft.AspNetCore.Http.HttpResults;
+using Microsoft.AspNetCore.Mvc;
+using static Microsoft.AspNetCore.Http.StatusCodes;
+
+namespace API.Controllers;
+
+[ApiVersion(2)]
+[ApiController]
+[Route("v{v:apiVersion}/[controller]")]
+public class VersionController : ControllerBase
+{
+    /// <summary>
+    /// The running build's identity: release tag (or branch@commit for untagged builds), commit, build time.
+    /// </summary>
+    /// <response code="200"></response>
+    [HttpGet]
+    [ProducesResponseType<VersionResponse>(Status200OK, "application/json")]
+    public Ok<VersionResponse> GetVersion() => TypedResults.Ok(VersionResponse.Current);
+}

api/API/openapi/API_v2.json

@@ -4980,6 +4980,26 @@
         }
       }
     },
+    "/v2/Version": {
+      "get": {
+        "tags": [
+          "Version"
+        ],
+        "summary": "The running build's identity: release tag (or branch@commit for untagged builds), commit, build time.",
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json; x-version=2.0": {
+                "schema": {
+                  "$ref": "#/components/schemas/VersionResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v2/Series/{MangaId}/volumes": {
       "get": {
         "tags": [
@@ -7265,6 +7285,25 @@
         "additionalProperties": false,
         "description": "Entry for a manga with unresolved chapters or missing files."
       },
+      "VersionResponse": {
+        "type": "object",
+        "properties": {
+          "version": {
+            "type": "string",
+            "nullable": true
+          },
+          "commit": {
+            "type": "string",
+            "nullable": true
+          },
+          "builtAt": {
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "The running build's identity, stamped at compile time by GitInfo + BuildInformation."
+      },
       "VolumeBundleState": {
         "enum": [
           "NotApplicable",
@@ -7396,6 +7435,9 @@
     {
       "name": "Settings"
     },
+    {
+      "name": "Version"
+    },
     {
       "name": "Volume"
     }

api/Tests/Integration/VersionEndpointTests.cs

@@ -0,0 +1,37 @@
+using System.Net.Http.Json;
+using System.Text.Json;
+using Xunit;
+
+namespace API.Tests.Integration;
+
+/// <summary>The deployed version must be discoverable from the GUI, so the API exposes its build identity.</summary>
+public class VersionEndpointTests : IAsyncLifetime
+{
+    private readonly PostgresFixture _postgres = new();
+    private string _dbName = null!;
+    private KenkuApplicationFactory _app = null!;
+
+    public async Task InitializeAsync()
+    {
+        _dbName = await _postgres.CreateDatabaseAsync();
+        _app = new KenkuApplicationFactory { PostgresConnectionString = _postgres.GetConnectionString(_dbName) };
+    }
+
+    public async Task DisposeAsync()
+    {
+        _app.Dispose();
+        await _postgres.DropDatabaseAsync(_dbName);
+    }
+
+    [Fact]
+    public async Task GetVersion_ReturnsTheBuildIdentity()
+    {
+        using var client = _app.CreateClient();
+
+        var json = await client.GetFromJsonAsync<JsonElement>("/v2/Version");
+
+        Assert.False(string.IsNullOrWhiteSpace(json.GetProperty("version").GetString()));
+        Assert.False(string.IsNullOrWhiteSpace(json.GetProperty("commit").GetString()));
+        Assert.False(string.IsNullOrWhiteSpace(json.GetProperty("builtAt").GetString()));
+    }
+}

web/website/app/app.vue

@@ -29,6 +29,7 @@
                 <UNavigationMenu :items="primaryNav" orientation="vertical" variant="link" class="-mx-2.5" />
                 <USeparator class="my-4" />
                 <UNavigationMenu :items="devLinks" orientation="vertical" variant="link" class="-mx-2.5" />
+                <AppVersion class="mt-4 block" />
             </template>
 
             <template #right>
@@ -57,6 +58,8 @@
                 <UDropdownMenu :items="devLinks as DropdownMenuItem[]" :content="{ align: 'end' }">
                     <UButton icon="i-lucide-ellipsis-vertical" color="neutral" variant="ghost" aria-label="More" class="max-sm:hidden" />
                 </UDropdownMenu>
+
+                <AppVersion class="max-lg:hidden" />
             </template>
         </UHeader>
 

web/website/app/components/AppVersion.vue

@@ -0,0 +1,9 @@
+<template>
+    <span v-if="version" class="font-mono text-xs text-dimmed" :title="`commit ${version.commit} · built ${version.builtAt}`">
+        {{ version.version }}
+    </span>
+</template>
+
+<script setup lang="ts">
+const { data: version } = useApi('/v2/Version', { key: 'Version', server: false });
+</script>

web/website/test/component/AppVersion.test.ts

@@ -0,0 +1,13 @@
+import { describe, it, expect, vi } from 'vitest';
+import { mountSuspended, registerEndpoint } from '@nuxt/test-utils/runtime';
+import AppVersion from '~/components/AppVersion.vue';
+
+registerEndpoint('/v2/Version', () => ({ version: 'v0.16.0', commit: 'abc1234', builtAt: '2026-06-11 14:00:00Z' }));
+
+describe('AppVersion', () => {
+    it('shows the deployed version from the API', async () => {
+        const wrapper = await mountSuspended(AppVersion);
+
+        await vi.waitFor(() => expect(wrapper.text()).toContain('v0.16.0'));
+    });
+});