-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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
Fix: Disable Telemetry when --no-version-updates
flag is enabled in cliOptions
#29635
base: next
Are you sure you want to change the base?
Fix: Disable Telemetry when --no-version-updates
flag is enabled in cliOptions
#29635
Conversation
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, 2 comment(s)
Edit PR Review Bot Settings | Greptile
const enableTelemetry = !( | ||
options.cliOptions.disableTelemetry || options.cliOptions.test === true | ||
options.cliOptions.disableTelemetry === true || | ||
options.cliOptions.test === true || | ||
options.cliOptions.versionUpdates === false | ||
); |
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 extracting these conditions into a separate function for better readability and reusability, e.g. shouldEnableTelemetry(options)
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 4fc23c0. 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. |
--no-version-updates
flag is enabled in cliOptions--no-version-updates
flag is enabled in cliOptions
Closes #29408
What I did
Add test code for disable withTelemetry when
--no-version-updates
flag is enabled in cliOptionsDisable Telemetry when
--no-version-updates
flag is enabled in cliOptionsChecklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
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: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
This PR modifies Storybook's telemetry behavior to respect the
--no-version-updates
CLI flag, ensuring telemetry is disabled when version updates are disabled.code/core/src/core-server/withTelemetry.ts
to disable telemetry whenoptions.cliOptions.versionUpdates === false
withTelemetry.test.ts
to verify telemetry is not called whenversionUpdates
is falsedisableTelemetry
flag andSTORYBOOK_DISABLE_TELEMETRY
env var