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
39 lines
1.5 KiB
Markdown
39 lines
1.5 KiB
Markdown
# 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 Releases
|
|
- `docs/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
|
|
|
|
1. **Version taggen** wie bisher (`git tag vX.Y.Z`, CI baut und deployed).
|
|
2. **`docs/releases/vX.Y.Z.md` anlegen** — Vorlage aus
|
|
`TEMPLATE.md` kopieren. Entwurf aus der Git-Historie seit dem letzten Tag
|
|
ableiten:
|
|
```sh
|
|
git log --oneline vX.Y.Z-1..vX.Y.Z
|
|
```
|
|
(Funktions-/Fix-Commits in die passenden Abschnitte übernehmen, API-Delta
|
|
anhand `lib/api-spec/openapi.yaml` prüfen.)
|
|
3. **Committen & pushen.** Der Sync-Schritt (`scripts/sync-release-docs.mjs`)
|
|
kopiert die Markdown-Dateien beim Frontend-Build automatisch nach
|
|
`artifacts/toolrate/public/docs/` und generiert `index.json`. Dadurch sind
|
|
die Releases im Deployment als `/docs/...` verfügbar.
|
|
|
|
> Hinweis: `index.json` und die kopierten Dateien unter
|
|
> `artifacts/toolrate/public/docs/` sind Build-Artefakte und werden bei jedem
|
|
> Build neu generiert — nicht von Hand bearbeiten.
|