Skip to content

docs(release): document smartem-frontend pipeline + refresh artefacts dropdown#204

Merged
vredchenko merged 1 commit into
mainfrom
docs/smartem-frontend-release-rollout
May 21, 2026
Merged

docs(release): document smartem-frontend pipeline + refresh artefacts dropdown#204
vredchenko merged 1 commit into
mainfrom
docs/smartem-frontend-release-rollout

Conversation

@vredchenko
Copy link
Copy Markdown
Collaborator

Summary

Follow-up to the smartem-frontend release pipeline going live (smartem-frontend#90, first stable release 0.1.0 produced earlier today alongside 0.1.0rc5). This PR propagates references to the new release across smartem-devtools:

  • docs/operations/releasing.md: add a fourth section for smartem-frontend, mirroring the existing three (decisions / epuplayer / workspace). Covers path filters, artifacts produced, the dual-file versioning rule (apps/smartem/package.json and apps/smartem/src/version.ts must match), the stable-release tag flow, and a short note on the /version runtime metadata endpoint. Expand the "Docker" subsection under "Verifying a release" to cover the new image alongside smartem-decisions.
  • core/artefacts.json: replace the placeholder frontend entry ("deployed via backend container, no standalone bundle published") with a real one mirroring the backend shape — label, description, docker pull command, and links to GitHub Releases and the GHCR package.

What this PR does NOT do

  • No k8s manifest changes — coming in a separate PR. There's also an API-endpoint resolution gap to think through first: the published image bakes VITE_API_ENDPOINT at build time but the release workflow doesn't set it, so the bundle's apiUrl() falls back to http://localhost:8000 at runtime. Worth deciding (relative /api + nginx reverse proxy in the SPA image, or per-environment build args, or runtime config injection) before writing k8s manifests that point at a backend the bundle can't reach.
  • No follow-up to wire packages/api/src/version-check.ts into main.tsx — tracked separately in smartem-frontend#93.

Verification

  • npm run typecheck in webui/ passes after the JSON edit (the entry conforms to the existing ArtefactItem type — same shape as backend).
  • python3 -c \"json.load(open('core/artefacts.json'))\" parses cleanly.
  • The releasing-docs page is auto-published to GitHub Pages — landing this PR will refresh that.

Test plan

  • CI lint/build passes on the PR
  • After merge, the GH Pages site renders the new "smartem-frontend" section in docs/operations/releasing.md
  • The deployed webui's "Artefacts" dropdown shows the SmartEM Frontend entry with the new docker pull command and links

Add a fourth section to docs/operations/releasing.md covering
smartem-frontend now that the pipeline added in ADR-0019 has
produced its first stable release (0.1.0) alongside RC builds:

- Path filters, artifacts, versioning model (dual file, must
  match), tag prefix, and the stable-release tag flow.
- A "Runtime version metadata" note describing the /version
  endpoint and where each field is sourced.
- Expand the "Docker" subsection of "Verifying a release" to
  cover the new frontend image alongside smartem-decisions.

Update the artefacts dropdown in the devtools webui: the
"frontend" entry is no longer a placeholder ("deployed via
backend container, no standalone bundle published") - now a
real published container image, mirroring the shape used by
the smartem-decisions backend entry (label, description,
docker pull command, GitHub Releases and Docker links).
@github-actions github-actions Bot added the documentation Improvements or additions to project documentation label May 21, 2026
@vredchenko vredchenko merged commit 85ef141 into main May 21, 2026
7 checks passed
@vredchenko vredchenko deleted the docs/smartem-frontend-release-rollout branch May 21, 2026 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to project documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant