docs: align the CI evidence inventory with delivered producer outputs

Aperta Adatta ai principianti
#4,144 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Leggi docs/process/ci-evidence.md insieme alle dichiarazioni nominate in scripts/ci-timings.ts e allo schema locale degli eventi in docs/process/ci-timings.md. Verifica i tipi di evento accettati dal publisher, i limiti e la sua invocazione esplicita. Poi aggiorna l’inventario per distinguere la raccolta disponibile dalla copertura osservata e gli eventi di coordinamento dalle annotazioni degli incidenti. Il lavoro è completato quando le voci e i link elencati descrivono questi comportamenti attuali e ogni producer non verificato resta indicato come lacuna.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

agent-ready area: ci area: docs priority: p2 type: docs

Context

At inspected main d974052166f335cbf57b385fddc13875da1b98de, the CI evidence inventory still describes hosted publication of work/wait/preemption events as planned under #2954 (docs/process/ci-evidence.md:94-105). #2954 is delivered: the current publish branch calls publishEvents (scripts/ci-timings.ts:620-621), and the documented command appends bounded immutable local coordination events to the data ref (docs/process/ci-timings.md:398-438).

The runner-slot-wait row likewise still calls #2952 planned, although runnerSlotWait already derives observed wait from job creation/start timestamps (scripts/ci-timings.ts:232-239).

The inventory can therefore send a report implementer looking for a producer that already exists. Publication is explicit: it does not mean every orchestrator emits or publishes events, and absent events must remain unknown. The publisher's documented event schema also excludes incident/classification annotations; do not infer those are published merely from the coordination publisher's delivery.

Found while reconciling #2948 after #4141.

Scope

Reconcile the inventory's #2954 publication and preemption descriptions, and its separately stale #2952 runner-slot-wait entry, with the delivered producer outputs. Verify actual event kinds, input bounds and explicit invocation. Keep availability of collection/publication separate from observed data coverage.

Out of scope

Publisher, collector, archive, report or workflow implementation; new event schemas; live collection/publication; permissions, contract or release changes; claiming complete worker/incident coverage; reopening #2954.

Acceptance criteria

  • Work lifetime, caller wait, local host-slot admission and preemption entries stop naming #2954 as unimplemented publication. The current publisher accepts preempted, so the row no longer says that kind is rejected.
  • The runner-slot-wait entry reflects the delivered #2952 implementation and its legacy unknowns; it no longer describes that producer as planned.
  • The inventory points to the existing publisher and says emission/publication is explicit; no emitted data remains unknown, rather than zero activity.
  • Coordination event kinds are distinguished from incident/classification annotations that this publisher does not accept. An unverified producer remains an explicit gap rather than being marked delivered.
  • Source and documentation links point at their named current declarations. The edit describes current behavior without adding a progress log.

Verification

Compare the revised descriptions with the publish branch, publishEvents validation and the documented local-event schema. No runtime change or paid call is needed. Run the repository's required PR preflight for the eventual documentation PR.

Contract impact

None. Documentation of existing internal measurement behavior.

Part of #2948.

Lingua principale
TypeScript
Stelle
4
Fork
0
Merge medio
6h 5m
PR unite (30g)
730

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di schlessera/brain-kit

Tutte le issue di schlessera/brain-kit

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.