Skip to content

build(sh): include BuildPointers.sol and forge fmt in build.sh#220

Open
thedavidmeister wants to merge 1 commit into
mainfrom
2026-06-24-issue-13-buildsh-pointers
Open

build(sh): include BuildPointers.sol and forge fmt in build.sh#220
thedavidmeister wants to merge 1 commit into
mainfrom
2026-06-24-issue-13-buildsh-pointers

Conversation

@thedavidmeister

@thedavidmeister thedavidmeister commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Summary

  • build.sh only regenerated the meta CBOR artifact; src/generated/ERC4626Words.pointers.sol required a separate manual invocation of forge script script/BuildPointers.sol + forge fmt.
  • Add a second sol-shell block to build.sh so a single ./script/build.sh regenerates all committed artifacts (meta CBOR + pointer constants + formatting) without extra manual steps.
  • The meta block stays in the default devshell (needs rain); the new pointer + fmt block runs in the sol-shell (needs forge).

Closes #13

Co-Authored-By: Claude noreply@anthropic.com

Summary by CodeRabbit

  • Chores
    • Updated the build process for generated artifacts.
    • Added an additional build step to refresh pointer constants and apply formatting consistently.

Currently build.sh only regenerates the meta CBOR artifact and stops.
Regenerating src/generated/ERC4626Words.pointers.sol requires a
separate manual step. Add a sol-shell block that runs BuildPointers.sol
and forge fmt so a single ./script/build.sh regenerates all committed
artifacts (meta/ + pointers + formatting) without extra manual steps.

Closes #13

Co-Authored-By: Claude <noreply@anthropic.com>
@thedavidmeister thedavidmeister self-assigned this Jun 24, 2026
@coderabbitai

coderabbitai Bot commented Jun 24, 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

Run ID: 9caa7637-75ee-48a4-9682-096dcf258c78

📥 Commits

Reviewing files that changed from the base of the PR and between 7415942 and b610aaf.

📒 Files selected for processing (1)
  • script/build.sh

Walkthrough

script/build.sh adds a new nix develop github:rainlanguage/rainix#sol-shell block that runs forge script --silent ./script/BuildPointers.sol and forge fmt. The header comment is updated to document that meta CBOR runs in the default devshell and pointer constants plus formatting run in the sol-shell.

Changes

Pointer regeneration in build.sh

Layer / File(s) Summary
build.sh: comment update and sol-shell pointer generation step
script/build.sh
Header comment is rewritten to describe the two-shell execution model (default devshell for meta CBOR with rain, sol-shell for pointer constants and forge fmt with forge). A new nix develop github:rainlanguage/rainix#sol-shell block is appended that executes forge script --silent ./script/BuildPointers.sol then forge fmt.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 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 is concise and accurately describes the main change to build.sh.
Linked Issues check ✅ Passed build.sh now covers pointer regeneration and formatting after the meta build, satisfying the linked issue's in-repo build-step requirement.
Out of Scope Changes check ✅ Passed The changes are limited to build.sh's regeneration flow and formatting step, with no unrelated additions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 2026-06-24-issue-13-buildsh-pointers

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.

Pointers regeneration (BuildPointers.sol) is not in any in-repo build step; the git-clean check depends on an external reusable workflow ass

1 participant