-
-
Notifications
You must be signed in to change notification settings - Fork 773
docs(runtime-config): emphasize NITRO_ env prefix requirement
#3906
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
Conversation
Added a warning note about variable prefixing in production.
|
@jamaluddinrumi is attempting to deploy a commit to the Nitro Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughDocumentation update to the configuration guide. The Production section now wraps existing guidance about NITRO_ prefixed environment variables in a warning block and introduces a clarifying note about key naming conventions between runtime config (camelCase) and environment variables (snake_case with uppercase). Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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 |
pi0
left a 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.
thnx!
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
🧹 Nitpick comments (1)
docs/1.docs/50.configuration.md (1)
97-98: Minor grammar issue in variable naming explanation.The phrasing "define key using camelCase" is awkward. Consider rephrasing to "define keys using camelCase" (plural) or "define the key using camelCase" (singular with article).
🔎 Suggested revision
-In runtime config, define key using camelCase. In environment variables, define key using snake_case and uppercase. +In runtime config, define keys using camelCase. In environment variables, define keys using snake_case and uppercase.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/1.docs/50.configuration.md
⏰ 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). (3)
- GitHub Check: tests-rollup (windows-latest)
- GitHub Check: tests-rollup (ubuntu-latest)
- GitHub Check: tests-rolldown (windows-latest)
🔇 Additional comments (1)
docs/1.docs/50.configuration.md (1)
87-107: Documentation improvement clearly conveys the NITRO_ prefix requirement.The warning block effectively highlights the critical prefix requirement, and the camelCase-to-snake_case naming examples are helpful. The update addresses the PR objective well.
NITRO_ prefix requirement
NITRO_ prefix requirementNITRO_ env prefix requirement
I'm just stumbled by runtime config must be prefixed with
NITRO_in .env file.I think it's a good idea to emphasize it in an alert component.
🔗 Linked issue
❓ Type of change
📚 Description
📝 Checklist