[RCA] Seal a human-reviewed public incident archive

Aperta
#14,234 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à
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
github, java
Ambito
cli, observability

Direzione di ricerca

Read the prerequisite issue #14230 and inspect the candidate release tree, transformation report, selection ledger, and archive writer after their seams are available. Start by adding focused behavioral tests with independently prepared fixtures; document and run the actual RED command before implementation. The work is done when the real bydbctl rca seal operation binds approval to the candidate digest and policy version, validates inputs, writes the bounded archive atomically, and passes the listed refusal and cancellation scenarios.

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

Descrizione

database enhancement

Umbrella: #14222

Blocked by: #14230

Summary

Seal a human-reviewed public incident archive. Deliver one usable operation, not a framework-only foundation.

Boundary

Proposed activation caller: bydbctl rca seal --candidate … --approval … --output …. Command names are proposed, not existing APIs.
Reporter collection runs with read-only source access; offline steps use local files only.
No source storage/wire-format changes are requested. The incident format is separately versioned.

Requirements

R1. Bind explicit human approval to the candidate content digest and policy version. Any later candidate edit invalidates approval.
R2. Validate the supported public manifest, allowed file types, coverage/omission summary and absence of private workspace paths/keys before packaging. Reject unresolved required reviews.
R3. Write one bounded archive format with per-file hashes and a format version; finalize atomically. Canonicalize the reviewed file inventory for its approval digest, but byte-for-byte reproducibility of compressed archives is not required.
R4. Include a minimal local incident/coverage summary and archive only. Do not upload, post or change file sharing permissions.

Acceptance criteria

  • Approve a fixed candidate, alter one byte, and assert sealing is refused. A clean candidate produces the independently expected file list and hashes without raw siblings.
  • Reject symlinks, duplicate paths and unsupported schema versions. Cancel during archive writing and verify no completed release exists.
  • Use hand-authored or independently captured fixtures with documented provenance; do not generate expected values using the code under test.
  • Add focused behavioral tests before implementation and record the actual RED command/failure, then GREEN results.
  • Keep existing CLI/API behavior compatible. Never overwrite unrelated user files; output conflicts must be refused.

Scope and readiness audit

  • Boundary and behavior: the single operation above; independently observable output and refusal behavior.
  • Production activation: the named CLI or skill entry point above, included in the same PR.
  • Packages/callers: candidate release tree, transformation report, selection ledger and archive writer.
  • Dependencies: #14230
  • Classification: planned blocked leaf; revalidate prerequisite seams after merge.
  • RED evidence: not executed during this planning task; no claim of passing or failing implementation tests.
  • End-to-end proof: the real command/skill scenarios above, not source-text assertions.
  • Formats/lifecycle/fixtures: private workspace or public archive only; artifact-specific fixture family above.
  • Focused tests: CLI leaves should add TestRCA… coverage under bydbctl/internal/cmd and/or the introduced collector package;
    run go test ./bydbctl/internal/cmd -run TestRCA -count=1 plus the new package tests. Skill leaves must add a replayable evaluation harness
    with an exact command documented in the PR. Final test names/paths are fixed when the prerequisite seam merges.
  • Resource/concurrency checks: cancellation, bounded reads/output and cleanup on failure; use repository panic-aware goroutine wrappers if concurrency is introduced.
  • Decision: one proposed PR. If the named behavior requires an unimplemented server API or another lifecycle change, stop and split that prerequisite.

Required-only scope audit

Human approval, integrity and a transferable archive are required; reproducible compression bytes and GitHub integration are not.

Removed/deferred: GitHub templates/API integration, signatures, multiple archive formats and reproducible compressed bytes.

Out of scope

GitHub API integration, signing infrastructure, automatic approval, binary-profile sanitization.

Lingua principale
Java
Stelle
25k
Fork
6.6k
Merge medio
12h 1m
PR unite (30g)
43

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 apache/skywalking

Tutte le issue di apache/skywalking

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.