From 91b457a802153b09d040cc99224caabc218319aa Mon Sep 17 00:00:00 2001 From: diegosouzapw Date: Wed, 13 May 2026 20:00:22 -0300 Subject: [PATCH] docs(release): add i18n / doc-links / env-doc checks to RELEASE_CHECKLIST MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Wires the new platform-overhaul gates into the Detailed Checklist used by the release-cut workflow: Documentation block: npm run check:docs-all (umbrella over sync, counts, env-doc, deprecated, doc-links) npm run check:env-doc-sync (code ↔ .env.example ↔ ENVIRONMENT.md parity) npm run check:doc-links (no broken internal markdown refs) i18n block (replaces stale `scripts/i18n-check.mjs` mention): npm run i18n:check (drift between source docs and .i18n-state.json) npm run i18n:check-ui-coverage (every locale ≥ 80% UI key coverage) npm run i18n:sync-ui:dry (0 missing keys across 40 locales) Note about running npm run i18n:run when source English docs change. These are the same checks newly enforced by the docs-sync-strict and i18n-ui-coverage CI jobs added in commit acf6b93d. Co-Authored-By: Claude Opus 4.7 (1M context) --- docs/ops/RELEASE_CHECKLIST.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/ops/RELEASE_CHECKLIST.md b/docs/ops/RELEASE_CHECKLIST.md index ae23447060..9756c01ac2 100644 --- a/docs/ops/RELEASE_CHECKLIST.md +++ b/docs/ops/RELEASE_CHECKLIST.md @@ -97,6 +97,9 @@ Breaking changes: add `BREAKING CHANGE:` footer or `!` after the scope (e.g. `fe ### Documentation - [ ] `npm run check:docs-sync` passes (auto-run by pre-commit) +- [ ] `npm run check:docs-all` passes (umbrella: docs-sync + docs-counts + env-doc-sync + deprecated-versions + doc-links) +- [ ] `npm run check:env-doc-sync` exits 0 — code ↔ `.env.example` ↔ `docs/reference/ENVIRONMENT.md` env contract is intact +- [ ] `npm run check:doc-links` exits 0 — no broken internal markdown references after restructuring - [ ] `docs/architecture/ARCHITECTURE.md` reviewed for storage/runtime drift - [ ] `docs/guides/TROUBLESHOOTING.md` reviewed for env var and operational drift - [ ] If `.env.example` changed: `docs/reference/ENVIRONMENT.md` updated @@ -107,8 +110,10 @@ Breaking changes: add `BREAKING CHANGE:` footer or `!` after the scope (e.g. `fe ### i18n -- [ ] Check `docs/i18n/` for major language drift against source docs -- [ ] Run `scripts/i18n-check.mjs` if present in repo +- [ ] `npm run i18n:check` exits 0 — translation state (`.i18n-state.json`) in sync with source docs (no drifted sources in strict mode; warn-mode advisory is acceptable for last-minute doc touch-ups, but should be 0 before tagging) +- [ ] `npm run i18n:check-ui-coverage` exits 0 — every UI locale at or above the 80% coverage floor +- [ ] `npm run i18n:sync-ui:dry` reports 0 missing keys across all 40 locales +- [ ] If source English docs changed, run `npm run i18n:run` (requires `OMNIROUTE_TRANSLATION_API_KEY` in `.env`) before tagging - [ ] Translation contributions can be deferred to next release if minor (track in CHANGELOG) ### Database Migrations