sudacode
9c7e02cbf0
- add `verify:config-example` script with tests to fail on missing/stale generated config artifacts - run the verification in CI and release workflows, and document it in release/docs guidance - fix docs-site Cloudflare Pages watch path to `docs-site/*` with regression coverage
1.9 KiB
id, title, status, assignee, created_date, updated_date, labels, dependencies, priority
| id | title | status | assignee | created_date | updated_date | labels | dependencies | priority | ||
|---|---|---|---|---|---|---|---|---|---|---|
| TASK-158 | Enforce generated config example drift checks | Done | 2026-03-10 20:35 | 2026-03-10 20:35 |
|
medium |
Description
The generated config.example.jsonc artifact is covered by generation-path tests, but there is no hard gate that fails when the checked-in example drifts from the canonical template. The in-repo docs-site copy can also drift silently.
Scope:
- add a first-party verification path that compares generated config-example content against committed artifacts
- fail fast when repo-root
config.example.jsoncis stale or missing - fail fast when
docs-site/public/config.example.jsoncis stale or missing, when the docs site exists - wire the verification into the normal gate and release flow
Acceptance Criteria
- #1 Automated verification fails when repo-root
config.example.jsoncis missing or stale. - #2 Automated verification fails when in-repo docs-site
public/config.example.jsoncis missing or stale, when docs-site exists. - #3 CI/release or equivalent project gates run the verification automatically.
Final Summary
Added src/verify-config-example.ts, which renders the canonical config template and compares it against the checked-in repo-root config.example.jsonc plus docs-site/public/config.example.jsonc when the docs site exists.
Wired the new verification into package.json as bun run verify:config-example, added regression coverage for missing and stale artifacts, and enforced the new check in both CI and release workflows.
Regenerated the checked-in config example artifacts so the new gate passes in the repo-local docs-site layout, and documented the release-step expectation in docs/RELEASING.md.