opencode
520f917723
Build & Push Docker Image / build (push) Successful in 2m35s
Adds a docs pipeline so each release has a version-bound Markdown document (docs/releases/vX.Y.Z.md) rendered publicly in the app: - sync-release-docs.mjs copies docs/releases/*.md into the toolrate public dir and generates index.json before every dev/build - /docs lists all releases; /docs/:version renders the sanitized Markdown (marked + DOMPurify, typography styles) - template + workflow documented in docs/README.md - current release (v0.6.0) documented as the first entry
1.5 KiB
1.5 KiB
Release-Dokumentation
Jeder Release hat eine version-gebundene Dokumentation unter
docs/releases/. Die Dokumentation wird öffentlich in der App unter
/docs (Index) und /docs/<version> (Detail) angezeigt.
Struktur
docs/releases/TEMPLATE.md— Vorlage für neue Releasesdocs/releases/vX.Y.Z.md— Dokumentation pro Release (eine Datei je Version)
Inhalt
Pro Release wird abgedeckt (kombiniert):
- Changelog: Neue Features, Fixes & Verbesserungen
- API-Änderungen: Neue/geänderte/entfernte Endpunkte (Delta zur Vorversion)
- Betrieb / Upgrade: Env-Vars, DB-Migrationen, Breaking Changes
Workflow beim Release
- Version taggen wie bisher (
git tag vX.Y.Z, CI baut und deployed). docs/releases/vX.Y.Z.mdanlegen — Vorlage ausTEMPLATE.mdkopieren. Entwurf aus der Git-Historie seit dem letzten Tag ableiten:(Funktions-/Fix-Commits in die passenden Abschnitte übernehmen, API-Delta anhandgit log --oneline vX.Y.Z-1..vX.Y.Zlib/api-spec/openapi.yamlprüfen.)- Committen & pushen. Der Sync-Schritt (
scripts/sync-release-docs.mjs) kopiert die Markdown-Dateien beim Frontend-Build automatisch nachartifacts/toolrate/public/docs/und generiertindex.json. Dadurch sind die Releases im Deployment als/docs/...verfügbar.
Hinweis:
index.jsonund die kopierten Dateien unterartifacts/toolrate/public/docs/sind Build-Artefakte und werden bei jedem Build neu generiert — nicht von Hand bearbeiten.