SLT.BETA.016 – Configurable preview suppression

[flyingrobots]

[SLT.BETA.016] Configurable preview suppression

Overview

Provide a flag and environment variable to disable Shiplog's interactive preview output, keeping CI logs concise while preserving previews by default for humans.

References & Assets

• Figma / Design: N/A
• Product Spec: N/A
• Related Issues / PRs: CI feedback thread
• Feature Flags / Experiments: N/A
• Other Assets: N/A

User Story

As a CI pipeline owner, I want to suppress Shiplog previews in non-interactive runs so that logs remain clean without losing structured output.

Acceptance Criteria

• CLI accepts --no-preview flag and SHIPLOG_NO_PREVIEW env toggle
• Preview suppression affects interactive table only; structured JSON still emitted
• Default behavior remains preview-on for interactive shells
• Documentation updated with examples
• Tests cover preview on/off modes

Definition of Done

Preview suppression flag/env shipped, docs updated, and tests validate suppressed output.

Scope

In-Scope

• Flag/env plumbing in CLI
• Output path adjustments for preview suppression
• Documentation and tests

Out-of-Scope

• Changes to structured output formats

Deliverables

• Est. Lines of Code: ~90
• Est. Blast Radius: lib/commands.sh, docs

Implementation Details

High-Level Approach

Detect flag/env before rendering preview, gate Bosun output accordingly, and ensure JSON output remains unchanged.

Affected Areas

• lib/commands.sh
• docs/features/run.md
• tests/run_preview.bats

Implementation Steps

• Add CLI flag and env variable handling
• Skip preview rendering when disabled
• Update docs and examples
• Add tests verifying suppressed preview output

Test Plan

Happy Path

• Default run shows preview
• --no-preview hides preview but outputs structured data

Edge Cases

• SHIPLOG_NO_PREVIEW=1 overrides flag defaults

Failure Cases

• Invalid env value surfaces helpful warning (if necessary)

Monitoring & Success Metrics

• CLI summary indicates preview suppression when active

QA Sign-off Matrix

Environment	Surface	Owner	Status	Notes
Local Docker	CLI	TBD	Pending	Covered via make test

Requirements

Hard Requirements

• Structured output unaffected when preview suppressed

Soft Requirements

• Provide CLI feedback that preview is disabled

Runtime Requirements

• Works in non-interactive shells and CI containers

Dependencies & Approvals

• Docs review

---

Production Notes

Priority: 2 / 5

Quality-of-life improvement (P3).

Complexity: 2 / 5

Limited CLI change.

Estimate: 4 - 6 hours

Includes plumbing, docs, tests.

Risk & Rollback

• Primary Risks: Users unaware preview hidden inadvertently
• Mitigations: CLI warning or summary note when disabled
• Rollback / Kill Switch: Revert flag handling

---

Additional Notes

Feedback sourced from CI users requesting quieter logs.

[flyingrobots]

Estimate: 2 hours.

Rationale:

• Add env/flag plumbing (--no-preview?) to skip preview rendering
• Ensure structured logging still fires when disabled
• Document usage and add tests