-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
Core: Disable SidebarContextMenu in static builds #29743
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 0768cd1. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
…bookjs/storybook into norbert/no-context-in-prod
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.
2 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings | Greptile
@@ -22,6 +22,7 @@ import { DocsPageWrapper } from '../lib/blocks/src/components'; | |||
import { isChromatic } from './isChromatic'; | |||
|
|||
const { document } = global; | |||
globalThis.CONFIG_TYPE = 'DEVELOPMENT'; |
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.
style: setting CONFIG_TYPE globally could affect other parts of the codebase that rely on this value. Consider using an environment variable or configuration option instead
const { document } = global; | ||
globalThis.CONFIG_TYPE = 'DEVELOPMENT'; |
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.
logic: this change forces development mode for all preview environments, which may have unintended consequences for production builds
if (globalThis.CONFIG_TYPE !== 'DEVELOPMENT') { | ||
return empty; | ||
} |
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.
style: Consider using process.env.NODE_ENV instead of globalThis.CONFIG_TYPE for more reliable environment detection
Closes #29741
What I did
I disabled the SidebarContextMenu in static builds
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
QA should include generating a static storybook, and verifying the context menu are not available
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH 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.ts
Make 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/core
team here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>
Greptile Summary
Implements conditional rendering of the SidebarContextMenu to prevent the focused test run tooltip from appearing in static/production builds of Storybook.
code/.storybook/preview.tsx
to setglobalThis.CONFIG_TYPE = 'DEVELOPMENT'
code/core/src/manager/components/sidebar/ContextMenu.tsx
to disable menu in production builds