Skip to content

feat: add advisory doc drift preview#143

Merged
marcusglee11 merged 1 commit into
mainfrom
build/doc-drift-advisory-sweep-122
Jul 8, 2026
Merged

feat: add advisory doc drift preview#143
marcusglee11 merged 1 commit into
mainfrom
build/doc-drift-advisory-sweep-122

Conversation

@marcusglee11

Copy link
Copy Markdown
Collaborator

Objective

Adds the first #122 advisory documentation drift sweep slice as a local dry-run issue preview.

No live issue creation, no cron activation, no doc mutation.

What changed

  • Added doc_steward/drift_sweep_issue_creator.py
    • reuses existing entrypoint freshness detection
    • groups findings by drift class
    • computes stable per-class fingerprints
    • builds JSON + Markdown issue previews
    • writes timestamped and latest preview files
    • records a dry-run/non-mutating receipt
  • Added doc_steward.cli drift-sweep-preview
    • requires explicit repo_root
    • supports --output-dir, --json, and --parent-link
  • Added tests_doc/test_drift_sweep_issue_creator.py
    • 31 tests covering all six drift classes, clean state, fingerprint stability, JSON/Markdown shape, output dir behavior, parent link, safe repeated runs, and CLI integration

Verification

python3 -m pytest tests_doc/test_drift_sweep_issue_creator.py -q
31 passed

python3 -m pytest tests_doc -q
256 passed, 1 skipped

python3 scripts/workflow/quality_gate.py check --scope changed ... --json
passed=true for blocking checks

python3 -m doc_steward.cli drift-sweep-preview . --output-dir /tmp/doc_drift_preview --json
wrote JSON/Markdown preview files; current clean checkout has 0 findings

ea-dispatch review --base-ref origin/main
APPROVE

Local caveat: mypy is advisory and unavailable in this WSL environment; hosted CI will provide final readback.

Boundaries held

  • No cron/scheduler activation.
  • No live GitHub issue creation/comment/close from product code.
  • No provider/model calls from product code.
  • No credential access.
  • No runtime/gateway changes.
  • No doc auto-fix.
  • No authority promotion/demotion.

Refs: #122, #141

@marcusglee11
marcusglee11 merged commit bf5acf0 into main Jul 8, 2026
5 checks passed
@marcusglee11
marcusglee11 deleted the build/doc-drift-advisory-sweep-122 branch July 8, 2026 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant