Skip to content

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

Merged
thedavidmeister merged 1 commit into
mainfrom
2026-08-20-strip-release-docs
Aug 20, 2026
Merged

Strip release-process narration from per-repo docs#144
thedavidmeister merged 1 commit 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 ~23-line header comment (rainix-tag-release runs cutRelease / freezes + regenerates the released-suites lib / verifies chains / publishes to Soldeer / commits both back to main, plus the why-not-autopublish lifecycle rationale) to one line of deploy-repo identity.
  • README.md "Deploying, and then releasing" step 3 — removed the rainix-tag-release mechanics (regenerate snapshot / verify chains / publish to Soldeer / commit frozen snapshot back to main — now stale).

Kept (repo-local facts / product docs)

The three-step deploy→verify→tag ordering and why it holds (deploy is idempotent, key-custody, workflow_dispatch-only; verify is scoped to released suites; a tag verifies and publishes but never broadcasts, which is why the deploy cannot fold into it); the lifecycle paragraph ([external.package].version is the last publish, historical versions unaffected). CLAUDE.md is unchanged — its release bullet already carries only repo-local invariants, no shared-workflow mechanics. cutRelease() docs elsewhere are left intact: it is THIS repo's own product code, not shared-workflow narration.

QA

Summary by CodeRabbit

  • Documentation
    • Simplified release workflow documentation.
    • Clarified that releases are manually triggered by pushing sol-v* tags.
    • Updated tagging guidance to explain that verification and publishing occur without broadcasting.

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: bbd0c55a-97e5-4e7c-a107-4c8925bd3242

📥 Commits

Reviewing files that changed from the base of the PR and between de870f9 and f63a09f.

📒 Files selected for processing (2)
  • .github/workflows/package-release.yaml
  • README.md

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


Walkthrough

The release workflow comment and README now provide concise documentation for manual sol-v* tag releases through rainix-tag-release. Detailed release mechanics were removed.

Changes

Release documentation

Layer / File(s) Summary
Release process documentation
.github/workflows/package-release.yaml, README.md
The workflow and README now identify rainix-tag-release and manual sol-v* tag triggering. The README retains verification and publication behavior while removing detailed snapshot and Soldeer steps.

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

Merge Risk: ⚪ Minimal · up to f63a0

This docs-only change removes duplicated release-process details without changing repository behavior; no actionable merge-blocking risk remains after normal checks and review.

Possibly related issues

  • rainlanguage/claude-audit-skills#91 — The changes remove duplicated release-process documentation and rely on rainix-tag-release as the release-process reference.

Suggested reviewers: claude

🚥 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 and concisely describes the documentation changes that remove release-process narration from repository files.
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.

@thedavidmeister
thedavidmeister merged commit f702d6e 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