Skip to content

Drop the stale snapshot enumeration from Build.sol - #29

Open
thedavidmeister wants to merge 1 commit into
mainfrom
2026-08-27-drop-stale-snapshot-enumeration
Open

Drop the stale snapshot enumeration from Build.sol#29
thedavidmeister wants to merge 1 commit into
mainfrom
2026-08-27-drop-stale-snapshot-enumeration

Conversation

@thedavidmeister

@thedavidmeister thedavidmeister commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

script/Build.sol named 0_1_3/0_1_4/0_1_5 as this repo's frozen
snapshots. src/generated/ holds 0_1_9, 0_1_10 and candidate, and
LibCloneFactoryReleased declares clone-factory@0_1_9 and
clone-factory@0_1_10. The list named none of the snapshots that are there and
omitted both that are.

Deleted rather than corrected, per the ruling on rainlanguage/rain.deploy#153.
The frozen snapshots are directories in src/generated/: the tree is the truth
and cannot drift from itself, so re-listing them in prose only re-arms the same
trap at the next release, and nothing expires a comment.

Only the enumeration goes. The clause it sat in is durable and stays: the frozen
snapshots are append-only historical records and run() never regenerates them,
which is what separates run() from cutRelease() and is not visible at this
call site. The two comment lines are a rewrap of the words already there; no
replacement prose was added.

QA

  • Discriminating tests: n/a - the diff deletes doc comment text only, no behaviour to discriminate. Verified by git diff: the only changed lines are two /// lines in the @notice above contract Build, and their replacements are the same words minus the enumeration, rewrapped.
  • Mutations applied: n/a - comment-only diff, there is no executable line in it to mutate.
  • Oracle: the tree, not the comment. ls src/generated/ gives 0_1_9, 0_1_10, candidate, and src/lib/LibCloneFactoryReleased.sol emits suite: "clone-factory@0_1_9" and suite: "clone-factory@0_1_10". There is no 0_1_3, 0_1_4 or 0_1_5 directory to match the deleted list, which is what makes it false, and it is read from the record and the generated lib rather than from any prose.
  • Category check: script/Build.sol enumerates frozen 0_1_3/0_1_4/0_1_5 snapshots the tree does not hold #28 asks for one enumeration in one file; covered script/Build.sol. Also grepped this repo for 0_1_3/0_1_4/0_1_5 across *.sol, *.md, *.yaml and *.toml outside lib/: that line was the only hit.

Closes #28

Summary by CodeRabbit

  • Documentation
    • Updated build documentation to describe frozen snapshots using a generic record location rather than specific historical versions.

The comment named `0_1_3`/`0_1_4`/`0_1_5` as the frozen snapshots.
`src/generated/` holds `0_1_9` and `0_1_10`, and `LibCloneFactoryReleased`
declares `clone-factory@0_1_9` and `clone-factory@0_1_10`, so the list
named none that are there and omitted both that are.

Deleted rather than corrected: the snapshots are directories in
`src/generated/`, the tree cannot drift from itself, and re-listing them
here only re-arms the trap at the next release. The clause they sat in is
durable and stays — frozen snapshots are append-only and `run()` never
regenerates them.

Closes #28

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: eaaad0e9-521b-4f25-ae8e-f348e290c7a2

📥 Commits

Reviewing files that changed from the base of the PR and between a6fa77c and 75077e8.

📒 Files selected for processing (1)
  • script/Build.sol

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


Walkthrough

The Build contract documentation now refers to frozen snapshots generically as src/generated/<tag>/ records. It no longer lists specific historical snapshot versions.

Changes

Build documentation

Layer / File(s) Summary
Generic frozen snapshot wording
script/Build.sol
The documentation replaces specific snapshot names with the generic src/generated/<tag>/ path.

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

Merge Risk: ⚪ Minimal · up to 75077

This is a localized documentation-only change that removes an inaccurate snapshot enumeration without changing build or release behavior. No actionable merge-blocking risk remains beyond normal checks and review.

🚥 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 the stale snapshot enumeration from script/Build.sol.
Linked Issues check ✅ Passed The change satisfies issue #28. It removes the inaccurate snapshot list, preserves the append-only and non-regeneration documentation, and uses generic src/generated/<tag>/ wording instead of anothe…
Out of Scope Changes check ✅ Passed The changes are limited to the documentation update required by issue #28. No unrelated code or behavioral changes are present.
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…
Full details: Linked Issues check

Explanation

The change satisfies issue #28. It removes the inaccurate snapshot list, preserves the append-only and non-regeneration documentation, and uses generic src/generated/&lt;tag&gt;/ wording instead of another enumeration.

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. (1 skipped: 1 unsupported.)

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

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.

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.

script/Build.sol enumerates frozen 0_1_3/0_1_4/0_1_5 snapshots the tree does not hold

1 participant