-
-
Notifications
You must be signed in to change notification settings - Fork 202
docs: add RAYON_NUM_THREADS environment variable documentation #3907
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.
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for biomejs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
WalkthroughThis pull request adds documentation for the RAYON_NUM_THREADS environment variable across the documentation and code generation files. The changes include a new reference section describing the variable's purpose (controlling Biome's internal thread pool size via Rayon), its scope (applies to all Biome commands), and usage examples for both per-process and global configuration. Additionally, a caution block is added to the big-projects guide warning about potential high CPU usage when running multiple Biome processes in parallel. No functional code changes are introduced. Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Important Action Needed: IP Allowlist UpdateIf your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:
Reviews will stop working after February 8, 2026 if the new IP is not added to your allowlist. 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/content/docs/reference/environment-variables.md (1)
1-6:⚠️ Potential issue | 🟠 MajorFix naming inconsistency between codegen output and documentation routing.
The codegen script writes to
environment_variables.md(underscore), butastro.config.tsreferencesenvironment-variables(hyphen). Both files currently exist with identical content and falsely claim auto-generation. Either update the codegen to write to the hyphen version, update the config to reference the underscore version, or remove the duplicate—but maintain only one source of truth to prevent drift.
|
I think I would rather introduce this as an actual feature rather than document this env var, in case we want to move away from rayon in the future. Maybe that doesn't matter that much tho because we could always have it as an alias. |
Summary
This PR adds documentation for the RAYON_NUM_THREADS environment variable to help users running multiple Biome instances in parallel (e.g., in monorepos or agentic workflows) to limit CPU usage and prevent resource contention.
Changes
Motivation
When running multiple Biome processes in parallel (e.g., with multiple agents in CI/CD), each instance can use 60-80% CPU, causing resource contention. The --threads flag only works for the ci command, but RAYON_NUM_THREADS works across ALL Biome commands, making it more convenient for limiting resource usage globally.
Testing