Skip to content

CLI: Only install Visual Test Addon if test feature is selected #30966

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

Merged
merged 3 commits into from
Mar 30, 2025

Conversation

ghengeveld
Copy link
Member

@ghengeveld ghengeveld commented Mar 28, 2025

Closes #30946

What I did

During create storybook / storybook init, does not add @chromatic-com/storybook (visual test addon) to the list of packages to install when the "test" feature is not selected.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/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 refines the create-storybook CLI by updating baseGenerator in code/lib/create-storybook/src/generators/baseGenerator.ts to conditionally include '@chromatic-com/storybook@^4.0.0-0' only when the test feature is enabled.

  • Modified baseGenerator logic to check for test feature before installing the VTA package.
  • Complements a prior check that removes unsupported test configurations.
  • Inline TODO on semver range update is flagged for future review.

@ghengeveld ghengeveld requested a review from JReinhold March 28, 2025 11:10
@ghengeveld ghengeveld changed the title CLI: Only initialize with @chromatic-com/storybook (VTA) if test feature is selected CLI: Only initialize with Visual Test Addon if test feature is selected Mar 28, 2025
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Copy link

nx-cloud bot commented Mar 28, 2025

View your CI Pipeline Execution ↗ for commit 4e22dea.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 50s View ↗

☁️ Nx Cloud last updated this comment at 2025-03-30 17:55:00 UTC

@shilman shilman changed the title CLI: Only initialize with Visual Test Addon if test feature is selected CLI: Only install Visual Test Addon if test feature is selected Mar 30, 2025
@shilman shilman added maintenance User-facing maintenance tasks patch:yes Bugfix & documentation PR that need to be picked to main branch and removed feature request labels Mar 30, 2025
@shilman shilman merged commit fdb13bd into next Mar 30, 2025
56 of 61 checks passed
@shilman shilman deleted the no-test-no-vta branch March 30, 2025 18:41
kasperpeulen pushed a commit that referenced this pull request Mar 31, 2025
CLI: Only install Visual Test Addon if test feature is selected
(cherry picked from commit fdb13bd)
shilman added a commit that referenced this pull request Apr 2, 2025
CLI: Only install Visual Test Addon if test feature is selected
(cherry picked from commit fdb13bd)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Apr 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: visual test ci:normal cli maintenance User-facing maintenance tasks patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Don't install VTA when the user opts out of testing
3 participants