Docs: Clarify webpack process.env requires variables to be set#34558
Docs: Clarify webpack process.env requires variables to be set#34558nitzan-treg wants to merge 2 commits into
Conversation
`added a warning callout to the angular/ember section of the env vars docs explaining that webpack 5 only injects process.env when the variable is actually defined at build time -- if it's not set, you get a "can't find variable: process" runtime error. also added a troubleshooting entry for that specific error with steps to fix it` Signed-off-by: nitzan-treg <nitzan.tregerman@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughUpdated documentation to clarify Webpack 5's Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
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.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/configure/environment-variables.mdx`:
- Line 15: Replace the typographic “smart” quotes used in JSX attributes with
ASCII double quotes in the Callout JSX (and any similar JSX tags) so MDX can
parse correctly; specifically update the Callout element attributes
variant=”info” and icon=”💡” (and the other occurrences on the same file at the
noted locations) to use plain " characters for variant and icon values in
docs/configure/environment-variables.mdx.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0fc695db-5a0b-4de6-b247-502d30a2c1ea
📒 Files selected for processing (1)
docs/configure/environment-variables.mdx
CodeRabbit correctly identified that typographic quotes break MDX parsing. Signed-off-by: nitzan-treg <nitzan.tregerman@gmail.com>
hey, saw #32322 and took a look
added a warning callout to the angular/ember section of the env vars docs explaining that webpack 5 only injects process.env when the variable is actually defined at build time -- if it's not set, you get a "can't find variable: process" runtime error. also added a troubleshooting entry for that specific error with steps to fix itfixes #32322
Closes #
What I did
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Caution
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit
processand guidance to define STORYBOOK_* variables at build time