Skip to content

chore(docs): update bun guide #2425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Aug 20, 2025
Merged

chore(docs): update bun guide #2425

merged 2 commits into from
Aug 20, 2025

Conversation

nicktrn
Copy link
Collaborator

@nicktrn nicktrn commented Aug 20, 2025

  • removed incorrect version info
  • fixed node cli warning that wasn't displaying before
  • moved known issues to the top
  • also removed references to snippets that don't exist anymore across the docs

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Aug 20, 2025

⚠️ No Changeset found

Latest commit: 1a3ae8d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 20, 2025 •
edited
Loading

Walkthrough

Across several MDX docs, snippet imports/usages related to upgrade and troubleshooting notes were removed. Specifically, UpgradeToV4Note was removed from two Lightpanda docs, and WorkerFailedToStartWhenRunningDevCommand imports/usages were removed from Next.js and Supabase guides (imports only in the Supabase files). The Bun framework guide was updated: description revised, Bun-version-specific warning replaced with a single warning about CLI support (Node.js required), a Known issues section about OpenTelemetry limitations with Bun was added, and a duplicate Known issues section at the end was removed. No exported/public entities were changed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/update-bun-guide

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Aug 20, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (2)
docs/guides/frameworks/bun.mdx (2)

12-15: Clarify Node vs Bun usage in CLI warning; fix brand capitalization; advise against bunx

Tighten wording and prevent confusion for Bun users.

Apply this diff:

 <Warning>
-  The trigger.dev CLI does not yet support Bun. So you will need to run the CLI using Node.js.
+  The Trigger.dev CLI does not yet support Bun. You must run the CLI using Node.js.
   Bun will still be used to execute your tasks, even in the `dev` environment.
+  Use npx/pnpm dlx/yarn dlx (Node) for the commands below; do not use bunx for the CLI.
 </Warning>

19-22: Reword Known issues item for accuracy and add actionable workaround

Avoids potentially misleading “Node’s register hook” phrasing and gives users next steps.

Apply this diff:

- - Certain OpenTelemetry instrumentation will not work with Bun, because Bun does not support Node's `register` hook. This means that some libraries that rely on this hook will not work with Bun.
+ - Some OpenTelemetry auto-instrumentations may not work with Bun because it doesn't currently implement Node's preloading/loader hooks (for example, the `-r/--require` mechanism) that these packages rely on.
+   Workarounds: use manual instrumentation for the affected libraries, or run your tasks with Node if you require those instrumentations.

If you’d like, I can add links to the upstream Bun issue and the OpenTelemetry Node auto-instrumentation docs for reference.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between b41129a and 1a3ae8d.

📒 Files selected for processing (6)
  • docs/config/extensions/lightpanda.mdx (0 hunks)
  • docs/guides/examples/lightpanda.mdx (0 hunks)
  • docs/guides/frameworks/bun.mdx (1 hunks)
  • docs/guides/frameworks/nextjs.mdx (0 hunks)
  • docs/guides/frameworks/supabase-edge-functions-basic.mdx (0 hunks)
  • docs/guides/frameworks/supabase-edge-functions-database-webhooks.mdx (0 hunks)
💤 Files with no reviewable changes (5)
  • docs/config/extensions/lightpanda.mdx
  • docs/guides/frameworks/supabase-edge-functions-basic.mdx
  • docs/guides/frameworks/supabase-edge-functions-database-webhooks.mdx
  • docs/guides/examples/lightpanda.mdx
  • docs/guides/frameworks/nextjs.mdx
🧰 Additional context used
🪛 LanguageTool
docs/guides/frameworks/bun.mdx

[grammar] ~8-~8: There might be a mistake here.
Context: ..."/snippets/framework-prerequisites.mdx"; import CliRunTestStep from "/snippets/st...

(QB_NEW_EN)

[grammar] ~9-~9: There might be a mistake here.
Context: ...Step from "/snippets/step-run-test.mdx"; import CliViewRunStep from "/snippets/st...

(QB_NEW_EN)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Analyze (javascript-typescript)

@nicktrn nicktrn merged commit 677b7ae into main Aug 20, 2025
7 checks passed
@nicktrn nicktrn deleted the chore/update-bun-guide branch August 20, 2025 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@ericallam ericallam ericallam approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nicktrn @ericallam