Skip to content

docs(release): refresh v0.2.0 launch signposts#656

Merged
flyingrobots merged 3 commits into
mainfrom
docs/v0.2.0-launch-signposts
Jun 27, 2026
Merged

docs(release): refresh v0.2.0 launch signposts#656
flyingrobots merged 3 commits into
mainfrom
docs/v0.2.0-launch-signposts

Conversation

@flyingrobots

Copy link
Copy Markdown
Owner

Linked Issue

Tracks #625. This does not close the release gate; #625 should close only after the signed v0.2.0 tag publishes and publication checks pass.

Branch / Issue-Title Check

  • Branch name exception: docs/v0.2.0-launch-signposts is a release signpost branch, not an issue-title slug.

Summary

  • Refresh release-facing docs and topic pages before the v0.2.0 signed tag.
  • Make pre-publication install wording honest: docs may show the 0.2.0 install command, but they no longer claim crates.io publication has already happened.
  • Add a durable pre-tag signpost pass to docs/topics/releases.md and docs/topics/docs-maintenance.md.
  • Record the launch signpost pass in the v0.2.0 verification packet.

Why

The release process requires repo-resident truth to be merged before the tag. After PR #655 landed the release prep, several signposts still read as if 0.2.0 was already published. This PR makes the launch state accurate without requiring a post-publication backfill merge.

Changes

  • Updated README.md, docs/GUIDE.md, docs/ENTRYPOINTS.md, and docs/site/index.md to distinguish release-target install commands from completed publication.
  • Updated docs/BEARING.md, docs/README.md, and docs/TECHNICAL_TEARDOWN.md for the current v0.2.0 launch state.
  • Added pre-tag launch/signpost coverage in docs/topics/releases.md, docs/topics/docs-maintenance.md, and docs/topics/README.md.
  • Updated docs/method/releases/v0.2.0/verification.md with PR chore(release): prepare v0.2.0 #655 merge evidence and this launch signpost validation.
  • Updated CHANGELOG.md so the 0.2.0 entry reflects this release-facing docs correction.

Method Evidence

  • Design doc linked or not required: not required; release documentation/signpost accuracy only.
  • Tests or validation evidence included below.
  • Playback/witness included or not required: docs/method/releases/v0.2.0/verification.md updated.
  • Retro or closeout evidence included or not required: not required before publication.

Tracker Hygiene

  • Release gate: current minor release #625 remains open as the release gate until tag/publication completion.
  • No repo-local backlog or progress tracker added.
  • Follow-up release work remains in GitHub Issues/Milestones.

Risk

Low. This is docs/signpost text only. The main risk is release wording drift; mitigated by docs-check, release-prep guard, and full preflight.

Backout

Revert this PR before tagging if the release wording is wrong. Do not tag v0.2.0 until main again contains accurate README, topic, release, and verification docs.

Testing

  • cargo xtask docs-check
  • node scripts/check-doc-cli-commands.mjs
  • cargo xtask release-prep-guard --version 0.2.0
  • BATS_LIB_PATH=test/vendor bats -t test/release-governance.bats test/docs-planning-boundary.bats
  • pnpm exec prettier --check ... on touched docs
  • git diff --check
  • cargo xtask preflight
  • Pre-push selected suite: Rust product preflight

EvidenceMap / SourceMap (if applicable)

Not applicable.

Screenshots / Logs (optional)

Not applicable.

Merge Strategy

  • Merge commit only; no rebase.
  • Delete branch after merge.
  • After merge, sync main, complete the release gate, create the signed v0.2.0 tag from synced main, run cargo xtask release-guard --tag v0.2.0, push the exact tag, and monitor publication.

Checklist

  • One-topic PR with tight diff
  • Rust-native preflight passes (cargo xtask preflight)
  • Release prep guard passes (cargo xtask release-prep-guard --version 0.2.0)
  • No widened permissions/secrets in workflows
  • Docs updated for release-facing behavior and version metadata

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@flyingrobots, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 42 minutes and 50 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: d1ab3985-e273-4c7a-8109-93ea81bc71b9

📥 Commits

Reviewing files that changed from the base of the PR and between 8bc51a7 and 3cf3990.

📒 Files selected for processing (15)
  • CHANGELOG.md
  • README.md
  • docs/BEARING.md
  • docs/ENTRYPOINTS.md
  • docs/GUIDE.md
  • docs/README.md
  • docs/TECHNICAL_TEARDOWN.md
  • docs/method/releases/v0.2.0/verification.md
  • docs/site/index.md
  • docs/topics/README.md
  • docs/topics/docs-maintenance.md
  • docs/topics/releases.md
  • scripts/check-doc-cli-commands.mjs
  • scripts/check-doc-cli-commands.test.mjs
  • test/technical-teardown.bats
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/v0.2.0-launch-signposts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@flyingrobots

Copy link
Copy Markdown
Owner Author

Self-audit finding for PR #656. Cc: @codex

Severity Source File Lines Issue Required action
P3 Self docs/TECHNICAL_TEARDOWN.md 296-302 The refreshed top section says release prep has landed on synced main, but the later Current Tensions section still says release preparation is blocked on the normal release branch, validation, and merge-to-main. That leaves contradictory release-state guidance in one signpost document. Replace the stale pre-merge blocker wording with the current post-prep, pre-tag state and add a narrow regression guard for this obsolete phrase.

@chatgpt-codex-connector

Copy link
Copy Markdown

Summary

  • Updated docs/TECHNICAL_TEARDOWN.md so the Current Tensions section no longer says release prep is blocked on branch/merge-to-main work; it now describes the current post-prep, pre-tag release boundary. docs/TECHNICAL_TEARDOWN.mdL298-L304
  • Added a narrow Bats regression guard that fails if the obsolete “normal release branch” blocker phrase is reintroduced. test/technical-teardown.batsL28-L31
  • Committed the changes on the current branch with commit 75c14d2 docs(release): align teardown pre-tag state.
  • Created a pull request with title docs(release): align teardown pre-tag state.

Testing

  • cargo xtask docs-check
  • git diff --check
  • grep -F "Release preparation is blocked only on the normal release branch" docs/TECHNICAL_TEARDOWN.md; test $? -eq 1
  • ⚠️ pnpm run preflight — blocked by environment/network limitation: pnpm audit --prod=false --json received 403 Forbidden from the npm audit endpoint.
  • ⚠️ BATS_LIB_PATH=test/vendor bats -t test/technical-teardown.bats — blocked because bats is not installed in this environment.

View task →

@flyingrobots

Copy link
Copy Markdown
Owner Author

Activity Summary

# Severity Source File Issue Commit Outcome
1 P3 Self-audit docs/TECHNICAL_TEARDOWN.md Current Tensions still used stale pre-merge release-blocker wording after the top section said release prep landed on synced main. 8fb29a0b Rewrote teardown wording to the current post-prep/pre-tag state; added test/technical-teardown.bats regression guard; recorded verification evidence.
2 P2 CI scripts/check-doc-cli-commands.mjs Repository hygiene preflight depended on cargo run --bin wesley -- --help; a transient Cargo registry failure produced an empty command set and false doc-command failures. 3cf3990f Replaced Cargo-backed discovery with source-backed parsing of crates/wesley-cli/src/main.rs; added Node regression coverage; recorded changelog and verification evidence.

Validation:

  • RED confirmed for issue 1 with BATS_LIB_PATH=test/vendor bats -t test/technical-teardown.bats failing on the obsolete phrase.
  • RED confirmed for issue 2 with node --test scripts/check-doc-cli-commands.test.mjs failing before the source-backed loader existed.
  • Local GREEN: node --test scripts/*.test.mjs; node scripts/check-doc-cli-commands.mjs; pnpm run legacy-preflight; cargo xtask docs-check; cargo xtask release-prep-guard --version 0.2.0; BATS_LIB_PATH=test/vendor bats -t test/technical-teardown.bats test/release-governance.bats test/docs-planning-boundary.bats; pnpm exec prettier --check CHANGELOG.md docs/method/releases/v0.2.0/verification.md scripts/check-doc-cli-commands.mjs scripts/check-doc-cli-commands.test.mjs; git diff --check; cargo xtask preflight.
  • Pre-push GREEN after final commit: Rust product preflight, JavaScript package preflight, repo Bats smoke suite.
  • Remote GREEN: all GitHub checks pass; HOLMES/WATSON/MORIARTY jobs skipped as expected for this docs/signpost change; CodeRabbit status is success after rate-limit review completion.

No unresolved review threads remain.

@flyingrobots flyingrobots merged commit 0c42621 into main Jun 27, 2026
16 checks passed
@flyingrobots flyingrobots deleted the docs/v0.2.0-launch-signposts branch June 27, 2026 09:10
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