Skip to content

Drop the "this repo has released none" comments - #154

Merged
thedavidmeister merged 2 commits into
mainfrom
2026-08-27-drop-stale-released-none-comments
Aug 27, 2026
Merged

Drop the "this repo has released none" comments#154
thedavidmeister merged 2 commits into
mainfrom
2026-08-27-drop-stale-released-none-comments

Conversation

@thedavidmeister

@thedavidmeister thedavidmeister commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

script/Deploy.sol and README.md step 2 both said this repo has released
nothing, so RegistryDeployChainTest has no subject and passes vacuously.

It has a subject. src/generated/0_1_7/{AddressRegistry,MigrationRegistry}.sol
is frozen on main, LibAddressRegistryReleased declares
address-registry@0_1_7 and LibMigrationRegistryReleased declares
migration-registry@0_1_7, so releasedSuites() returns two suites and the
chain group forks every supported network against them. A reader is told the
test is inert when it is the opposite.

Deleted rather than corrected, per the ruling on #153. Naming 0_1_7 re-arms the
same trap: the next release falsifies it again and nothing expires a comment.
Deletion removes the class instead of resetting the clock.

  • script/Deploy.sol — the whole trailing paragraph. Whether releasedSuites()
    is empty is a fact about a return value, readable at that function; what
    RegistryDeployChainTest covers belongs in its own doc, not restated here.
    The "deploy before tag" ordering it ended on is already stated earlier in the
    same comment ("something has to put it on chain first, and a sol-v* tag is
    not it ... before tagging").
  • README.md — the three transient lines of step 2 only. The durable first
    sentence stays: the chain test passes only once every released suite is live
    on every supported network, with the code that release froze. Step 3 already
    carries the ordering rationale ("which is exactly why step 1 cannot be folded
    into it").

No replacement prose. Items 2 and 3 of #153 are sibling repos, with their own
issues and PRs: rainlanguage/rain.math.float.deploy#14 and
rainlanguage/rain.factory.deploy#28.

QA

  • Discriminating tests: n/a - the diff deletes doc comment and README prose only, no behaviour to discriminate. Verified by git diff: every removed line is a /// line or a README list line, and no non-comment byte changes.
  • Mutations applied: n/a - comment-only diff, there is no executable line in it to mutate.
  • Oracle: the tree, not the comment. src/generated/0_1_7/AddressRegistry.sol and src/generated/0_1_7/MigrationRegistry.sol exist on main, and src/lib/LibAddressRegistryReleased.sol / src/lib/LibMigrationRegistryReleased.sol emit suite: "address-registry@0_1_7" and suite: "migration-registry@0_1_7" into releasedSuites(). That is what makes the deleted sentences false, and it is read from the frozen record and the generated libs rather than from any prose.
  • Category check: Stale comments claim 'this repo has released none' in three repos that now have frozen records #153 asks for three comments across three repos; this PR covers the two in this repo (script/Deploy.sol, README.md) and closes it as the machinery owner. Items 2 and 3 are in sibling repos and are covered by DecimalFloatDeployChainTest's comment claims this repo has cut no release, but 0_1_1 is frozen rain.math.float.deploy#14 and script/Build.sol enumerates frozen 0_1_3/0_1_4/0_1_5 snapshots the tree does not hold rain.factory.deploy#28. Also checked the rest of this repo for the same claim: the other "has released nothing" hits (RainDeployVerifyChainEmpty.t.sol, RainDeployVerifySnapshotBase.sol, LibRainDeploySnapshot.sol and their tests) are statements about the machinery's behaviour for any repo in that state, not claims about this repo, and are still true - left alone.

Closes #153

Summary by CodeRabbit

  • Documentation
    • Simplified deployment and release verification documentation.
    • Removed outdated explanations about initial suite availability and verification behavior.
    • Removed redundant internal documentation about deployment verification tests.

Both said the chain group has no subject and passes vacuously. It has
one: `src/generated/0_1_7/` is frozen and the released libs declare
`address-registry@0_1_7` and `migration-registry@0_1_7`.

Correcting them to name 0_1_7 re-arms the same trap, since the next
release falsifies it again and nothing expires a comment. Whether
`releasedSuites()` is empty is a fact about a return value, readable at
that function; what `RegistryDeployChainTest` covers belongs in its own
doc rather than restated at the call site. The README keeps the durable
half of step 2 — the chain test passes only once every released suite is
live on every supported network, with the code that release froze — and
the ordering rationale it needs is already in step 3.

Closes #153

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Aug 27, 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: 6ca17df4-34b0-4adb-ae5b-1cd1c8c42c83

📥 Commits

Reviewing files that changed from the base of the PR and between fb47e30 and 0d212ae.

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

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


Walkthrough

The change removes obsolete release verification explanations from README.md and script/Deploy.sol. Contract behavior and public declarations remain unchanged.

Changes

Cohort / File(s) Summary
Verify documentation cleanup
README.md, script/Deploy.sol
Removed outdated verification guidance and the RegistryDeployChainTest comment. No executable code changed.

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

Merge Risk: ⚪ Minimal · up to 0d212

This PR removes stale documentation without changing repository behavior or release machinery, so no actionable merge-blocking risk remains after normal checks and review.

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 describes the main change: removing stale comments that state the repository has released no suites.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 2026-08-27-drop-stale-released-none-comments

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.

#155 renamed RegistryDeployChainTest to RegistryDeployVerifyTest inside
the paragraph this branch deletes, so main re-added it in updated form
still carrying the false claim. The deletion stands.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@thedavidmeister
thedavidmeister merged commit 1ee3b3f into main Aug 27, 2026
5 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.

Stale comments claim 'this repo has released none' in three repos that now have frozen records

1 participant