Skip to content

docs: align v0.8 adoption release guidance - #534

Merged
jeffhuber merged 1 commit into
mainfrom
codex/docs-v08-consistency-audit
Sep 2, 2026
Merged

docs: align v0.8 adoption release guidance#534
jeffhuber merged 1 commit into
mainfrom
codex/docs-v08-consistency-audit

Conversation

@jeffhuber

Copy link
Copy Markdown
Contributor

Summary

  • align active rollout, roadmap, cloud, and release docs with the current v0.8 package line
  • prefer adoption doctor and the native Code Mower Board in getting-started docs
  • clarify production PyPI release flow after no-publish verification, with TestPyPI reserved for setup/risky packaging
  • add release-hygiene coverage for stale beta and adoption wording

Verification

  • scripts/dev-python -m unittest tests.test_release_hygiene
  • scripts/dev-python -m code_mower.migration release-readiness --repo-path . --json
  • scripts/dev-python -m unittest discover -s tests
  • scripts/dev-python -m ruff check .
  • scripts/dev-python scripts/privacy_scan.py
  • scripts/dev-python scripts/actionlint_generated_workflows.py
  • Markdown link audit: checked 66 files, missing_count 0

@jeffhuber jeffhuber added builder:codex Code Mower generated label tier:R Code Mower generated label needs-claude-audit needs-gitar-audit Code Mower generated label labels Sep 2, 2026
@jeffhuber

Copy link
Copy Markdown
Contributor Author

Claude audit (merge-authority lane)

Head SHA: 4f373823c7b2da65adfbc5710c9ee327a598a25f
Findings: P0=0, P1=0, P2=0, P3=2 (blocker policy: any P0/P1/P2 -> BLOCKED)

Claude Audit: PASS

Summary:

Docs-only consistency pass aligning v0.8 adoption guidance (doctor preset renamed, pipx install pattern hardened, stale beta/version references removed), backed by an updated regression test (test_active_docs_use_current_beta_release_language) that greps the touched docs for stale phrases. Cross-checked the diff against the new/updated test assertions and found the docs match what the tests require; no code paths changed. No P0/P1/P2 issues found.

Findings:

  • [P3] Loosened production PyPI publish gate -- docs/pypi-release.md:146
    Finding ID: claude:6345c2bf81fe157f9316
    The dispatch-matrix guidance changed from 'production publish only after TestPyPI passes' to allowing routine beta publishes straight to production PyPI once the no-publish verification run is green, with TestPyPI reserved for 'first-time trusted-publishing setup or risky packaging changes.' This is a real reduction in the pre-production safety net (PyPI releases are effectively irreversible) but it's stated with explicit rationale and is an internally consistent, deliberate documentation choice rather than an objective defect — flagging for the release owner to confirm intent, not a merge blocker.
  • [P3] Subject-verb mismatch in updated release-notes prose -- docs/early-adopter-v05.md:157
    Finding ID: claude:b32a079b6839911f521d
    "Later v0.5 beta dogfood follow-ups keep owner-bound work out of lane WIP, adds lane-liveness..." mixes plural 'follow-ups keep' with singular 'adds' in the same sentence — a copy-editing nit, non-blocking.

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

Code Mower notice: previously audited head 4f373823c7b2 is no longer an ancestor of current head 8791ca7efe3b; commits may have been dropped. Only current-head audit verdicts count.

@gitar-bot

gitar-bot Bot commented Sep 2, 2026

Copy link
Copy Markdown
Code Review ✅ Approved

Aligns v0.8 adoption release guidance across active rollout, roadmap, cloud, and release documentation. Clarifies production PyPI release flow after no-publish verification and adds release-hygiene coverage for stale beta and adoption wording. All verification checks passed. No issues found.

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Auto-apply Compact
gitar auto-apply:on         
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@jeffhuber

Copy link
Copy Markdown
Contributor Author

Claude audit (merge-authority lane)

Head SHA: 8791ca7efe3be2e6e035c3771310e0d0a3f4b146
Findings: P0=0, P1=0, P2=0, P3=1 (blocker policy: any P0/P1/P2 -> BLOCKED)

Claude Audit: PASS

Summary:

Docs-only PR that aligns v0.8 adoption/release guidance across seven docs and adds a corresponding release-hygiene test (test_active_docs_use_current_beta_release_language) that verifies stale v0.5/v0.6/v0.7 phrasing was removed and current beta language is present. Spot-checked the new test's assertions against the actual doc edits; all match. No code paths, CLI behavior, or CI gates are changed.

Findings:

  • [P3] Release runbook loosens TestPyPI-first guidance -- docs/pypi-release.md:178
    Finding ID: claude:90d61311f1c5dd682866
    The matrix row and surrounding prose now say routine beta publishing 'can go from the green no-publish verification run to production PyPI' and only recommends TestPyPI 'for first-time trusted-publishing setup or risky packaging changes,' replacing the prior blanket 'Use only after TestPyPI passes.' This is a real policy relaxation for a security-sensitive publish gate. It doesn't appear to contradict docs/oss-v1-checklist.md (which plausibly covers the one-time initial public release setup rather than routine releases), so it is not clearly a broken contract, but worth a maintainer sanity check that this is the intended risk tradeoff.

@jeffhuber
jeffhuber merged commit 1ea496d into main Sep 2, 2026
15 checks passed
@jeffhuber
jeffhuber deleted the codex/docs-v08-consistency-audit branch September 2, 2026 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

builder:codex Code Mower generated label claude-audit-done needs-gitar-audit Code Mower generated label tier:R Code Mower generated label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant