Skip to content

Strip release-process narration from per-repo docs - #15

Merged
thedavidmeister merged 2 commits into
mainfrom
2026-08-20-strip-release-docs
Aug 20, 2026
Merged

Strip release-process narration from per-repo docs#15
thedavidmeister merged 2 commits into
mainfrom
2026-08-20-strip-release-docs

Conversation

@thedavidmeister

@thedavidmeister thedavidmeister commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Docs-only. Strip release-process narration that this per-repo doc restates but does not own.

Human ruling (2026-08-20): "you really shouldn't put release processes in the per repo docs because it's super fragile." The release process is owned by rainix's rainix-tag-release.yaml reusable; per-repo restatements drift the moment the reusable changes — which just happened: rainlanguage/rainix#338 / rainlanguage/rainix#339 made tag-release push-free, so this repo's "commits the frozen snapshot back to main" was already factually wrong.

Removed

  • .github/workflows/package-release.yaml — collapsed the header comment (rainix-tag-release verifies prod at regenerated pins / publishes to Soldeer / commits the frozen snapshot back to main) to one line of deploy-repo identity.
  • CLAUDE.md "Releases and versioning" — removed the step-by-step rainix-tag-release mechanics (writes version into foundry.toml, regenerates snapshot, verifies chains, publishes to Soldeer, commits snapshot back to main — now stale) and the "never broadcasts, only attests" narration.
  • README.md "Releases" — removed the same rainix-tag-release mechanics sentence (regenerate / verify / publish / commit-back — now stale).

Kept (repo-local invariants an agent would get wrong from the repo alone)

[package].version is the last-released version not a next-version slot (a normal PR does not bump it); a manual sol-v* tag is the sole release trigger; the on-chain deploy is a manual dispatch run BEFORE tagging and tagging never broadcasts; src/generated/<tag>/ snapshots are frozen/append-only.

QA

Summary by CodeRabbit

  • Documentation
    • Updated release guidance to clarify that releases are manually triggered with version tags.
    • Clarified that deployment occurs before tagging and that the release process does not broadcast deployments.
    • Simplified repository guidance and directed readers to the dedicated tooling for detailed release mechanics.
    • Documented deployment consistency requirements, including version tracking and generated artifact handling.

The release process is owned by rainix's rainix-tag-release reusable and
restating it per-repo drifts: rainlanguage/rainix#338 made tag-release
push-free, so the 'commits the snapshot back to main' narration here was
already stale. Docs-only; repo-local invariants kept, mechanics point to
rainix.

Ruling: rainlanguage/claude-audit-skills#91
Philosophy: rainlanguage/rainix#298

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@thedavidmeister thedavidmeister self-assigned this Aug 20, 2026
@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 6e381178-46f3-4088-ae2e-74826eb91ce8

📥 Commits

Reviewing files that changed from the base of the PR and between 237eff9 and c887651.

📒 Files selected for processing (1)
  • CLAUDE.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


Walkthrough

The workflow comment and repository documentation now describe manual sol-v<version> tag releases. Release mechanics are delegated to rainix, and detailed repository guidance was reduced to key conventions and deployment invariants.

Changes

Release documentation alignment

Layer / File(s) Summary
Manual release contract
.github/workflows/package-release.yaml, README.md, CLAUDE.md
The release documentation now identifies manual sol-v<version> tags as the release trigger, delegates release mechanics to rainix, and records compiler, deployment-pin, and generated-file conventions.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to c8876

This docs-only change removes stale release-process narration without changing product or deployment behavior; no actionable merge-blocking risk remains.

Possibly related issues

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: removing release-process narration from repository documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 2026-08-20-strip-release-docs

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.

Most of the file was discoverable content the cap gate targets (build/test
command listings, CI job breakdown, file-by-file architecture, dep list).
Kept only the non-discoverable invariants: interfaces-live-in-rain.factory,
pragma pins, deterministic-address hazards, frozen/append-only snapshots, the
last-released [package].version, and the manual-deploy-before-tag shape.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@thedavidmeister
thedavidmeister merged commit 7fd3ee7 into main Aug 20, 2026
4 checks passed
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