Skip to content

End-to-End Validation, Docs and Reuse Alignment #958

@SorraTheOrc

Description

@SorraTheOrc

Summary

Finalize quality gates and documentation so the audit field change ships as a minimal end-to-end slice.

User-visible outcome

Operators can trust the new audit flow with clear usage docs and verified behavior across write/read paths.

Scope

  • Add end-to-end test coverage for create or update, redaction, and show output.
  • Update user-facing docs and help text for audit behavior.
  • Cross-check prior related work to reuse patterns and avoid duplication.
  • Keep explicit note that automated migration from legacy comments is out of scope.

Minimal End-to-End Slice

  • Code: any final wiring required for integrated behavior.
  • Tests: integration tests spanning update, storage, and show output.
  • Docs: concise usage and scope notes.
  • Infra/Ops: no new services; migration and command usage documented.
  • Observability: test assertions prove data contract and redaction outcomes.

Related implementation details

  • tests for update and show commands
  • CLI reference and migration notes
  • prior work items: WL-0MLG60MK60WDEEGE and WL-0MM369NX61U76OVY

Reuse notes

Reuse test patterns and structured output expectations from prior audit-related improvements.

Acceptance Criteria

  • Integration coverage validates write, overwrite, redaction, and show rendering.
  • Help and docs describe --audit-text behavior and overwrite semantics.
  • Scope notes state no automatic migration of legacy comment-based audits.
  • Related prior work is referenced to minimize duplicated implementation.
  • Plan remains executable as a small, complete vertical slice.

Deliverables

  • End-to-end tests
  • Documentation and help updates
  • Reuse alignment notes in implementation artifacts

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions