docs: document minimum bun version requirement - #642
Conversation
|
@r69shabh is attempting to deploy a commit to the Databuddy OSS Team on Vercel. A member of the Team first needs to authorize it. |
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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. Comment |
Greptile SummaryAdds Bun 1.2.0 as the documented minimum version needed for the repository’s dependency protocol.
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains. Important Files Changed
Reviews (2): Last reviewed commit: "docs: document minimum bun version requi..." | Re-trigger Greptile |
The
catalog:protocol used throughoutpackage.jsonfor shared dependencies requires Bun 1.2.0+. On older versions,bun installfails with a confusing error about "git clone" for@types/bun, which looks like a network problem but is actually just an unsupported feature.Added
"bun": ">=1.2.0"to theenginesfield inpackage.jsonand a one-line note to the install step in CONTRIBUTING.md.Noticed this while setting up locally to work on #638.
Summary by cubic
Clarifies and enforces a minimum Bun version to support the
catalog:protocol and prevent misleading install errors. Previouslybun installon Bun <1.2.0 failed with agit cloneerror for@types/bun; now we require Bun ≥1.2.0 and document the exact Bun version pinned viapackageManagerto avoid install conflicts."bun": ">=1.2.0"to theenginesfield inpackage.json.CONTRIBUTING.mdto call out the minimum and the pinned Bun version (with Corepack activation guidance).Developer action
bun --version.packageManagerto install and run locally.Written for commit 6fdaca9. Summary will update on new commits.