Skip to content

docs: document minimum bun version requirement - #642

Open
r69shabh wants to merge 2 commits into
databuddy-analytics:stagingfrom
r69shabh:docs/bun-version-requirement
Open

docs: document minimum bun version requirement#642
r69shabh wants to merge 2 commits into
databuddy-analytics:stagingfrom
r69shabh:docs/bun-version-requirement

Conversation

@r69shabh

@r69shabh r69shabh commented Aug 20, 2026

Copy link
Copy Markdown

The catalog: protocol used throughout package.json for shared dependencies requires Bun 1.2.0+. On older versions, bun install fails 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 the engines field in package.json and 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. Previously bun install on Bun <1.2.0 failed with a git clone error for @types/bun; now we require Bun ≥1.2.0 and document the exact Bun version pinned via packageManager to avoid install conflicts.

  • Adds "bun": ">=1.2.0" to the engines field in package.json.
  • Updates CONTRIBUTING.md to call out the minimum and the pinned Bun version (with Corepack activation guidance).

Developer action

  • Upgrade Bun to ≥1.2.0 and verify with bun --version.
  • Use the pinned Bun version from packageManager to install and run locally.

Written for commit 6fdaca9. Summary will update on new commits.

Review in cubic

@r69shabh
r69shabh requested a review from izadoesdev as a code owner August 20, 2026 20:46
@vercel

vercel Bot commented Aug 20, 2026

Copy link
Copy Markdown

@r69shabh is attempting to deploy a commit to the Databuddy OSS Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f9659297-d507-46f7-8188-85b911e7e417

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

@greptile-apps

greptile-apps Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds Bun 1.2.0 as the documented minimum version needed for the repository’s dependency protocol.

  • Declares "bun": ">=1.2.0" in the root package’s engines field.
  • Adds the minimum version and a version-check command to the contribution setup instructions.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
CONTRIBUTING.md Documents Bun 1.2.0 as the minimum version for dependency installation and tells contributors how to check their version.
package.json Adds the Bun minimum-version declaration to the root package metadata.

Reviews (2): Last reviewed commit: "docs: document minimum bun version requi..." | Re-trigger Greptile

Comment thread package.json
@izadoesdev
izadoesdev deleted the branch databuddy-analytics:staging August 21, 2026 09:05
@izadoesdev izadoesdev closed this Aug 21, 2026
@izadoesdev izadoesdev reopened this Aug 21, 2026
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.

2 participants