diff --git a/docs/project/backlog/README.md b/docs/project/backlog/README.md index 880540a..0800e33 100644 --- a/docs/project/backlog/README.md +++ b/docs/project/backlog/README.md @@ -43,37 +43,38 @@ WP-19's own file), so it's a separate manual/CI step, not chained into the other Gates land before the work they cover; each lint rule lands in the same WP as the fixes for its existing violations, so every WP ends green. -| WP | Title | Phase | Status | -| ---------------------------------------- | ------------------------------------------------------------ | --------------------------- | ------ | -| [WP-01](WP-01-axe-ci-gate.md) | Axe-on-every-story CI gate | 0 · gates | done | -| [WP-02](WP-02-check-tokens.md) | Harden `check:tokens` + fix what it catches | 0 · gates | done | -| [WP-03](WP-03-contracts-purity.md) | Boundaries I: contracts purity + ApiClient confinement | 0 · gates | done | -| [WP-04](WP-04-ui-not-infrastructure.md) | Boundaries II: `ui ↛ infrastructure` + showcase sanction | 0 · gates | done | -| [WP-05](WP-05-parse-boundaries.md) | Parse-don't-validate closure + MDX | 1 · FP/DDD | done | -| [WP-06](WP-06-typed-async.md) | Generic async template contexts — kill `$any()` | 1 · FP/DDD | done | -| [WP-07](WP-07-brief-idioms.md) | Brief on the shared idioms + RemoteData MDX | 1 · FP/DDD | done | -| [WP-08](WP-08-store-idiom.md) | One store idiom + machine naming + TEA MDX | 1 · FP/DDD | done | -| [WP-09](WP-09-pure-logic.md) | Pure-logic closure: dates + missing command specs | 1 · FP/DDD | done | -| [WP-10](WP-10-button-fidelity.md) | CIBG button fidelity | 2 · CIBG | done | -| [WP-11](WP-11-markup-fidelity.md) | CIBG markup fidelity: application-link + absent-class triage | 2 · CIBG | done | -| [WP-12](WP-12-datablock.md) | CIBG Datablock for application data | 2 · CIBG | done | -| [WP-13](WP-13-cibg-gap-register.md) | CIBG-gap register + hygiene + MDX | 2 · CIBG | done | -| [WP-14](WP-14-storybook-taxonomy.md) | Storybook taxonomy reorg + Layers MDX | 3 · Storybook | done | -| [WP-15](WP-15-missing-stories.md) | Missing stories: shell + brief components | 3 · Storybook | done | -| [WP-16](WP-16-component-a11y.md) | Component a11y: description wiring + alert role | 4 · a11y | done | -| [WP-17](WP-17-app-a11y.md) | App-level a11y: route focus, template lint, WCAG checklist | 4 · a11y | done | -| [WP-18](WP-18-abac-capability-spine.md) | ABAC capability spine (Principal + capabilities, phase P1) | 5 · productie-volwassenheid | done | -| [WP-19](WP-19-e2e-smoke.md) | Playwright e2e smoke | 5 · productie-volwassenheid | done | -| [WP-20](WP-20-second-locale.md) | Second locale proof | 5 · productie-volwassenheid | done | -| [WP-21](WP-21-resilience-seams.md) | Resilience seams (correlation-id, idempotency, retry) | 5 · productie-volwassenheid | done | -| [WP-22](WP-22-durable-persistence.md) | Durable persistence (optional tier) | 5 · productie-volwassenheid | done | -| [WP-23](WP-23-org-template-backend.md) | Org-template backend + admin role | 6 · Brief v2 | done | -| [WP-24](WP-24-letter-canvas.md) | Letter canvas (edit on the letter) | 6 · Brief v2 | done | -| [WP-25](WP-25-letter-preview-html.md) | Server-rendered letter preview (HTML; PDF deferred) | 6 · Brief v2 | todo | -| [WP-26](WP-26-org-template-editor.md) | Admin org-template editor | 6 · Brief v2 | done | -| [WP-27](WP-27-brief-ux-layer.md) | Brief UX layer (undo/redo, standaardbrief, diff) | 6 · Brief v2 | todo | -| [WP-28](WP-28-brief-v2-demo-polish.md) | Brief v2 demo polish (scenarios, e2e, docs) | 6 · Brief v2 | todo | -| [WP-29](WP-29-stamdata-beheer-editor.md) | Stamdata beheer editor (low-code, PR-emitting) | follow-on · ADR-0004 | done | +| WP | Title | Phase | Status | +| ---------------------------------------- | -------------------------------------------------------------------------- | --------------------------- | ------ | +| [WP-01](WP-01-axe-ci-gate.md) | Axe-on-every-story CI gate | 0 · gates | done | +| [WP-02](WP-02-check-tokens.md) | Harden `check:tokens` + fix what it catches | 0 · gates | done | +| [WP-03](WP-03-contracts-purity.md) | Boundaries I: contracts purity + ApiClient confinement | 0 · gates | done | +| [WP-04](WP-04-ui-not-infrastructure.md) | Boundaries II: `ui ↛ infrastructure` + showcase sanction | 0 · gates | done | +| [WP-05](WP-05-parse-boundaries.md) | Parse-don't-validate closure + MDX | 1 · FP/DDD | done | +| [WP-06](WP-06-typed-async.md) | Generic async template contexts — kill `$any()` | 1 · FP/DDD | done | +| [WP-07](WP-07-brief-idioms.md) | Brief on the shared idioms + RemoteData MDX | 1 · FP/DDD | done | +| [WP-08](WP-08-store-idiom.md) | One store idiom + machine naming + TEA MDX | 1 · FP/DDD | done | +| [WP-09](WP-09-pure-logic.md) | Pure-logic closure: dates + missing command specs | 1 · FP/DDD | done | +| [WP-10](WP-10-button-fidelity.md) | CIBG button fidelity | 2 · CIBG | done | +| [WP-11](WP-11-markup-fidelity.md) | CIBG markup fidelity: application-link + absent-class triage | 2 · CIBG | done | +| [WP-12](WP-12-datablock.md) | CIBG Datablock for application data | 2 · CIBG | done | +| [WP-13](WP-13-cibg-gap-register.md) | CIBG-gap register + hygiene + MDX | 2 · CIBG | done | +| [WP-14](WP-14-storybook-taxonomy.md) | Storybook taxonomy reorg + Layers MDX | 3 · Storybook | done | +| [WP-15](WP-15-missing-stories.md) | Missing stories: shell + brief components | 3 · Storybook | done | +| [WP-16](WP-16-component-a11y.md) | Component a11y: description wiring + alert role | 4 · a11y | done | +| [WP-17](WP-17-app-a11y.md) | App-level a11y: route focus, template lint, WCAG checklist | 4 · a11y | done | +| [WP-18](WP-18-abac-capability-spine.md) | ABAC capability spine (Principal + capabilities, phase P1) | 5 · productie-volwassenheid | done | +| [WP-19](WP-19-e2e-smoke.md) | Playwright e2e smoke | 5 · productie-volwassenheid | done | +| [WP-20](WP-20-second-locale.md) | Second locale proof | 5 · productie-volwassenheid | done | +| [WP-21](WP-21-resilience-seams.md) | Resilience seams (correlation-id, idempotency, retry) | 5 · productie-volwassenheid | done | +| [WP-22](WP-22-durable-persistence.md) | Durable persistence (optional tier) | 5 · productie-volwassenheid | done | +| [WP-23](WP-23-org-template-backend.md) | Org-template backend + admin role | 6 · Brief v2 | done | +| [WP-24](WP-24-letter-canvas.md) | Letter canvas (edit on the letter) | 6 · Brief v2 | done | +| [WP-25](WP-25-letter-preview-html.md) | Server-rendered letter preview (HTML; PDF deferred) | 6 · Brief v2 | todo | +| [WP-26](WP-26-org-template-editor.md) | Admin org-template editor | 6 · Brief v2 | done | +| [WP-27](WP-27-brief-ux-layer.md) | Brief UX layer (undo/redo, standaardbrief, diff) | 6 · Brief v2 | todo | +| [WP-28](WP-28-brief-v2-demo-polish.md) | Brief v2 demo polish (scenarios, e2e, docs) | 6 · Brief v2 | todo | +| [WP-29](WP-29-stamdata-beheer-editor.md) | Stamdata beheer editor (low-code, PR-emitting) | follow-on · ADR-0004 | done | +| [WP-30](WP-30-ci-perf-followups.md) | CI performance follow-ups (node_modules cache, runner image, path filters) | follow-on · CI/infra | todo | Sequencing dependencies (stated in the WPs too): 01 before 10–15 (axe covers story churn); 03/04 before 05–09 (boundaries stop new violations during refactors); 06 before 07 (typed diff --git a/docs/project/backlog/WP-30-ci-perf-followups.md b/docs/project/backlog/WP-30-ci-perf-followups.md new file mode 100644 index 0000000..f5238ed --- /dev/null +++ b/docs/project/backlog/WP-30-ci-perf-followups.md @@ -0,0 +1,63 @@ +# WP-30 — CI performance follow-ups + +Status: todo +Phase: follow-on · CI/infra + +## Why + +Tier-1 CI speedups shipped in `708d4c2` (CodeQL off the PR path, Playwright/NuGet caches, +`npm ci` flags) and the demo web image shrank to `node:24-slim`. These are the remaining +options that were deliberately deferred — bigger changes, policy calls, or things that need +Gitea runner-admin access. Revisit once there's an actual CI-timing breakdown to prioritise by, +or when someone confirms act_runner access. + +Constraint carried over: **CI runs are not observable from the agent's environment** — validate +any workflow edit by watching a real Gitea run; ship one change at a time so a red run is easy to +bisect and revert. **The `docker compose` images are NOT used by CI** (CI = Gitea `ubuntu-latest` +runner image, set on the act_runner host). + +## Read first + +- `.github/workflows/ci.yml` (current 6 jobs + the Tier-1 caches already in place). +- The `ci-and-local-gate` note (agent memory) — CI traps + what's already done. +- `docker-compose.yml` (demo images; `node:24-slim` done, dotnet SDK still full). + +## Candidate items (pick per impact once measured) + +1. **Skip `npm ci` install via a `node_modules` cache.** `actions/cache` on `node_modules` + keyed by `package-lock.json` hash; on a hit, `npm ci` is near-instant across the 4 npm jobs. + Bigger win than the existing npm-download cache, but a ~777 MB cache with a small staleness + risk — best if the runner's cache storage is local/fast. Medium effort, low-medium risk. +2. **Smaller CI runner image.** + - _Real fix (needs runner admin):_ point act_runner's `ubuntu-latest` (or a new label) at a + smaller image with node + dotnet preinstalled. Biggest startup win. **Blocked on confirming + act_runner access.** + - _Repo-only partial:_ `container: node:24-slim` on the node-only jobs (`frontend`, + `storybook-a11y`), dropping `setup-node`. Doesn't help the node+dotnet jobs (`e2e`, + `api-client-drift`, `backend`) — a combined image would need building/pushing (new infra). + Risky on act_runner, unverifiable locally → stage alone, last. +3. **Path-filtered jobs.** Skip `backend` on FE-only changes and vice-versa (workflow `paths:` + or `dorny/paths-filter`). Cuts compute on narrow PRs; watch required-check rules that expect + every job to report a status. +4. **Split a fast `lint` job** (lint + format:check + check:tokens) for ~1 min fail-fast + feedback — only worth it once item 1 (node_modules cache) lands, else it duplicates `npm ci`. +5. **Lean deployable backend image** (optional, not for the dev demo): multi-stage prod build on + `mcr.microsoft.com/dotnet/aspnet:10.0` (~220 MB) in a separate `docker-compose.prod.yml`. The + dev `docker-compose.yml` keeps the SDK image because `dotnet run` hot-reload needs it. + +## Acceptance criteria + +- [ ] Each chosen item verified GREEN on a real Gitea run (watched, since it's not observable + from the agent env), landed as its own revertable commit. +- [ ] `npm run ci` still passes locally after any workflow/script change. + +## Out of scope + +- nx/turbo/remote build caching (overkill for this repo size). +- Rewriting the dev compose into prod images (would lose bind-mount hot reload). + +## Risks + +- Unverifiable-from-agent workflow edits can only be confirmed on the runner — one change per + commit, revert on red. +- act_runner-level changes depend on infra access this repo doesn't control.