Doc hygiene, tag-triggered release job, move dashboard to ansible

- Bump stale v0.1.0 install pins to v0.3.0; lead mail docs with Mailpit
  (homelab default) instead of Mailtrap; document new modules.
- Add a `release` CI job that runs on `vX.Y.Z` tag push: re-verifies
  build/test, checks tag == package.json version and that CHANGELOG.md
  documents it, then creates a Gitea release via the API with an
  npm-pack tarball attached. Needs a one-time GITEA_TOKEN repo secret.
- Remove the standalone dashboards/playkit-overview.json — superseded
  by a generated `live-playkit` board in ansible deploy/observability,
  which is now wired to a real Pushgateway.
This commit is contained in:
2026-07-14 20:39:48 -04:00
parent 7369b1c5e5
commit c079fefe12
7 changed files with 130 additions and 86 deletions
+7
View File
@@ -1,5 +1,12 @@
# Changelog
## Unreleased
- CI: add tag-triggered `release` job (`.gitea/workflows/ci.yml`) — re-runs build/test, verifies tag matches `package.json` version and `CHANGELOG.md` documents it, creates a Gitea release with an `npm pack` tarball attached. Requires a one-time `GITEA_TOKEN` Actions secret.
- Docs: bump install pin examples from `v0.1.0` to `v0.3.0` (README, CONSUMER.md)
- Docs: lead with Mailpit (homelab default) instead of Mailtrap in README email section; use `createMailInbox()` + `readMailHtml()` in the example instead of a provider-specific client
- Ops: Pushgateway + `live-playkit` Grafana board now provisioned via ansible `deploy/observability/` (pending `make deploy-observability`); removed the standalone `dashboards/playkit-overview.json` (superseded) and the `dashboards` entry from `package.json` `files`
## 0.3.0 — 2026-07-14
- **Zod schema asserts** — `assertSchema()` + optional `schema` on `ApiClient` requests