feat(admin): show the deployed commit and build time in the admin (#233)
Linting / lint (pull_request) Successful in 2m38s
SonarQube Analysis / sonarqube (pull_request) Failing after 29m40s

There was no way to tell which build an environment was running. That is not hypothetical: minutes after #232 merged, `npm run backfill:images` in QA failed with `tsx: not found` because the container was still serving the pre-merge image, and the only thing that revealed it was npm echoing the old script line. Had the change been anywhere other than a package.json script, the container would have looked healthy while running the wrong code.

The header now reads something like `a5076cc · built 29 Aug 20:36`. The commit answers "is this the code I expect"; the build time answers "did my redeploy actually rebuild", which is a different question and the one that would have caught the case above.

The commit is read out of `.git` directly rather than by shelling out, because node:20-bookworm-slim has no git binary and adding an apt layer so the image can print seven characters is a poor trade. `.git` is copied into the build stage only — verified absent from the final image — so no repository history reaches a deployed container.

Resolution is pure and separately tested across every shape that actually occurs: a detached HEAD holding the object name, which is what a checkout of a ref produces; a symbolic HEAD followed to a loose ref file; the same followed to packed-refs, which is what a fresh clone commonly has; peeled `^` tag lines ignored so an annotated tag cannot yield the wrong commit; and every failure path returning `unknown`. That last part is the one that matters most — this runs during a Docker build, and a version stamp must never be the thing that stops a deploy.

Served from a gated /api/admin/version rather than folded into /api/config. That endpoint is public, and a commit hash there would tell any storefront visitor exactly which revision of a public repository is deployed. An integration test asserts the gate and asserts the public config does not carry it, because the boundary is the whole point rather than an implementation detail.

Verified in the built image rather than argued: the stamp inside it reads a5076cc, matching `git rev-parse --short HEAD`, and a running container serves it from /api/admin/version while /api/config returns only what it did before.

Backend: 296 unit, 263 integration, tsc clean, lint unchanged at six pre-existing warnings. Frontend builds clean with its two pre-existing warnings untouched.

Closes #233
This commit is contained in:
2026-08-29 15:37:12 -05:00
parent a5076cc217
commit 44328d0b5c
9 changed files with 499 additions and 1 deletions
+13 -1
View File
@@ -10,7 +10,19 @@ WORKDIR /app/backend
COPY backend/package.json ./
RUN npm install
COPY backend/ ./
RUN npm run build
# Only this stage ever sees .git, and the final image below copies just `dist`,
# so no repository history reaches the deployed container. The build reads the
# commit out of it directly rather than shelling out to git, because this base
# image has no git binary and adding an apt layer so the image can print seven
# characters is a poor trade. See #233.
#
# There is no .dockerignore, so .git is in the build context here and in
# Portainer, which clones the repository before building.
COPY .git ./.git
# writeBuildInfo runs against the compiled output, so it has to follow tsc. It
# warns rather than fails when .git is unreadable: a deploy must never be
# stopped by the thing whose only job is to say which deploy it is.
RUN npm run build && node dist/writeBuildInfo.js
FROM node:20-bookworm-slim
WORKDIR /app