Skip to content

docs(spec): add release readiness proof contract#254

Merged
EffortlessSteven merged 1 commit into
mainfrom
docs/release-readiness-proof-contract
May 13, 2026
Merged

docs(spec): add release readiness proof contract#254
EffortlessSteven merged 1 commit into
mainfrom
docs/release-readiness-proof-contract

Conversation

@EffortlessSteven

@EffortlessSteven EffortlessSteven commented May 13, 2026

Copy link
Copy Markdown
Member

Summary:

  • add SHIPPER-SPEC-0002 for the release-readiness proof contract
  • add the 0.4.0 release-readiness plan that makes PR 15: 0.4.0-rc.1 release dry-run proof #195 executable from the spec stack
  • record the verified shipper plan order for 13 publishable crates without running dry-runs or creating the readiness artifact yet

Non-goals:

  • no docs/release/0.4.0-readiness.md
  • no publish, tag, or runtime behavior change
  • no support-tier promotion yet

Validation:

  • cargo run -p shipper -- plan
  • cargo xtask check-doc-contracts --mode advisory
  • cargo xtask policy-report
  • cargo xtask check-file-policy --mode blocking-allowlist
  • cargo fmt --all -- --check
  • git diff --cached --check

@gemini-code-assist

gemini-code-assist Bot commented May 13, 2026

Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented May 13, 2026

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@coderabbitai

coderabbitai Bot commented May 13, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@EffortlessSteven has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 41 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 79132a98-844a-408e-829e-9dfc71ef8761

📥 Commits

Reviewing files that changed from the base of the PR and between f3f5888 and 0303350.

📒 Files selected for processing (2)
  • docs/specs/SHIPPER-SPEC-0002-release-readiness-proof.md
  • plans/0.4.0/release-readiness-proof.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/release-readiness-proof-contract

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 and usage tips.

@factory-droid

factory-droid Bot commented May 13, 2026 •
edited
Loading

Copy link
Copy Markdown

Droid finished @EffortlessSteven's task —— View job

Droid Review Complete — PR #254

Status: approved

Summary

No actionable findings emitted.

Inspected Surfaces

  • docs/specs/SHIPPER-SPEC-0002-release-readiness-proof.md (new spec document)
  • plans/0.4.0/release-readiness-proof.md (new plan document)

Checks Performed

  • Verified no source code changes in diff (pure docs only)
  • Verified no behavioral changes to shipper-core, shipper-cli, or shipper crates
  • Verified spec and plan internal link consistency (SHIPPER-SPEC-0001, SHIPPER-PROP-0001, SHIPPER-ADR-0001, plans/0.4.0/source-of-truth-stack.md)
  • Verified required evidence gates match existing CI commands (cargo fmt, clippy, test, audit, doc, xtask check-doc-contracts, xtask policy-report)
  • Verified dry-run table completeness against shipper plan output (13 crates in topological order)
  • Verified acceptance examples are consistent with spec non-goals (no publish, tag, or runtime behavior)
  • Verified support-tier promotion rule requires readiness artifact existence (PR 15: 0.4.0-rc.1 release dry-run proof #195 deliverable)
  • Verified no tokens, secrets, or credential handling (docs-only)
  • Verified no unsafe code paths (docs-only)
  • Verified events.jsonl/state.json/receipt.json invariants not implicated (no state changes)

Why No Comments

This PR adds only documentation: a reusable release-readiness spec (SHIPPER-SPEC-0002) and an executable plan for #195 (0.4.0 release-readiness-proof). The diff touches no Rust source code, introduces no new behavioral contracts, and does not modify any publish/preflight/resume/reconcile surfaces. The spec and plan pass all referenced proof commands on their face, and no runtime behavior can be affected.

Residual Risk

  • The readiness artifact (docs/release/0.4.0-readiness.md) is not yet produced; it is gated behind PR 2 (PR 15: 0.4.0-rc.1 release dry-run proof #195)
  • The plan order table is a snapshot; if shipper plan output changes before PR 2 executes, the later output is authoritative per spec

Validation Signal

  • Observed: Diff contains only two new markdown files; no source code changes
  • Reported: PR description confirms non-goals (no publish, tag, runtime behavior change)
  • Not verified: Actual execution of proof commands (cargo xtask check-doc-contracts, cargo xtask policy-report) — not run in this review

@EffortlessSteven EffortlessSteven merged commit d72f58b into main May 13, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@EffortlessSteven