docs: define the Echo 1.0 release contract and move live planning to GitHub - #582
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (9)
📝 WalkthroughWalkthroughAdds the Echo 1.0 release contract (four binary gates with evidence requirements and compatibility policy), the WAL/WSC durability doctrine (durable authority, recovery bootstrap, evidence relationships), GitHub-native sequencing constraints with proof policy, a doctrine validation script with fixture-based test harness, and cross-document wiring to stabilize the release framework and durability model. ChangesEcho 1.0 Release Contract and Durability Doctrine
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Possibly related issues
Suggested labels
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
|
@codex Self-Code Review findings for PR #582.
Validation run during review:
|
|
Summary
Testing
|
|
@codex Review-fix update pushed in 2cf7d25. Resolved the four self-review findings:
Validation before push:
|
|
Summary
Testing
|
|
@codex Second Self-Code Review findings for PR #582 at head
Validation run during this review:
|
|
Summary
Testing
|
|
@codex Second review closure pushed in
Verification run before commit/push:
Pre-commit and pre-push hooks also passed on the pushed head. |
|
Summary
Testing
|
|
GP0 pivot pushed in @codex please sanity-check the revised shape: this PR now treats the GitHub Project as the live roadmap and the repository as the place for stable release promises and doctrine.
Intentional follow-up, not folded into this repo commit:
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: caa4c92e08
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| Gate D requires a clean-room reproducible build, exact cross-repository | ||
| compatibility set, upgrade and rollback tests, package and documentation | ||
| verification, all four gate issues closed by evidence-bearing PRs, and a | ||
| release candidate generated only from the pinned compatibility set. |
There was a problem hiding this comment.
Avoid making Gate D require itself to close
In the Gate D release-candidate path, this makes the contract self-blocking: Gate D cannot be the final release-integrity proof if its own pass criteria require all four gate issues, including Gate D (#588), to already be closed. The earlier dependency statement scopes D to Gates A/B/C, so this should require the prerequisite gates/evidence packets rather than “all four gate issues” being closed before D can pass.
Useful? React with 👍 / 👎.
| "Close issues only when their executable exit criteria have passed" | ||
|
|
||
| reject_literal "Work boundary removes audit date" "$workitems" "Last audited:" | ||
| reject_literal "Work boundary removes source audit table" "$workitems" "| Open count/status |" |
There was a problem hiding this comment.
Match the actual open-count table header
When a future edit restores the pre-pivot WorkItems open-count table, this guard will not catch it because the removed header was | Source | Open count | Notes |, not | Open count/status |; I verified that appending that table to a fixture still lets check-wal-wsc-doctrine.sh pass. Since the new WorkItems boundary explicitly forbids restoring open-count tables, reject a literal/pattern that matches the actual header or Open count column.
Useful? React with 👍 / 👎.
| @@ -0,0 +1,280 @@ | |||
| #!/usr/bin/env bash | |||
There was a problem hiding this comment.
Wire the doctrine guard into automated checks
This new guard currently is not invoked by any committed hook or CI path: repo-wide search only finds the script itself and its self-test, while verify-local.sh/.github/workflows/ci.yml do not call it. That means the release-contract and Project-link invariants can regress on the next docs edit even though the PR presents this as an executable guard, unless contributors remember to run it manually.
Useful? React with 👍 / 👎.
| "Recovery bootstraps from WAL root or storage manifest material" | ||
|
|
||
| reject_literal "sequencing removes update date" "$sequencing" "Last updated:" | ||
| reject_literal "sequencing removes current chunk" "$sequencing" "## Current Chunk" |
There was a problem hiding this comment.
Reject the removed First Chunk tracker too
The stale sequencing section that was removed was headed ## First Chunk and contained [5/10 slices] checkpoint bars, but this guard only rejects ## Current Chunk; I verified that appending the old First Chunk block to the sequencing doc still lets the checker pass. Since that block is exactly live roadmap state, the guard should reject the actual old heading or its progress-bar/checkpoint literals.
Useful? React with 👍 / 👎.
| The live architecture hardening focus is selected in the GitHub Project and | ||
| issues. Repo docs may explain why a boundary exists, but they must not become | ||
| the current execution tracker. |
There was a problem hiding this comment.
Remove the live tracker still embedded in BEARING
This new statement says repo docs must not be the execution tracker, but the same BEARING file still contains a Roadmap Status table and a Causal WAL Forty-Five Slice Plan with “Track progress here” and checked slice inventories below it. Since BEARING is the required context-recovery entrypoint, leaving that live tracker in place still directs readers to repository status instead of the GitHub Project and contradicts the pivot this PR is trying to enforce.
Useful? React with 👍 / 👎.
Summary
docs/releases/echo-1.0-contract.mdas the stable Echo 1.0 release constitutiondocs/WorkItems.mdand sequencing docs to GitHub-native tracking boundaries instead of issue inventoriesGitHub release control surface
Validation
scripts/check-wal-wsc-doctrine.shscripts/tests/check_wal_wsc_doctrine_test.shpnpm exec prettier --check CHANGELOG.md docs/BEARING.md docs/WorkItems.md docs/design/wal-wsc-durability-roadmap.md docs/design/work-item-sequencing-and-prioritization.md docs/index.md docs/releases/echo-1.0-contract.mdpnpm exec markdownlint-cli2 CHANGELOG.md docs/BEARING.md docs/WorkItems.md docs/design/wal-wsc-durability-roadmap.md docs/design/work-item-sequencing-and-prioritization.md docs/index.md docs/releases/echo-1.0-contract.mdshellcheck scripts/check-wal-wsc-doctrine.sh scripts/tests/check_wal_wsc_doctrine_test.shbash -n scripts/check-wal-wsc-doctrine.sh scripts/tests/check_wal_wsc_doctrine_test.shscripts/check_spdx.sh CHANGELOG.md docs/BEARING.md docs/WorkItems.md docs/design/wal-wsc-durability-roadmap.md docs/design/work-item-sequencing-and-prioritization.md docs/index.md docs/releases/echo-1.0-contract.md scripts/check-wal-wsc-doctrine.sh scripts/tests/check_wal_wsc_doctrine_test.shgit diff --checkcargo checkSummary by CodeRabbit
Documentation
Chores