Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Core: Detect no matching export error in storybook start and build #24877

Merged
merged 3 commits into from Nov 22, 2023

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Nov 16, 2023

Closes #23992

What I did

This PR adds a detection step when running storybook dev or storybook build for the infamous No matching exports error (refer to the issue), which is mostly caused by version inconsistencies in Storybook.

Hopefully this will aid users to fix the issues themselves, but ideally this error should give them a command to run, like storybook doctor, which could tell exactly what package to upgrade. For now, we do our best with an error message.

Before:
image

After:
image

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!

This is tricky to test, I don't know if it's possible in the monorepo.

  1. Create a sandbox
  2. Change the version of storybook to something old, e.g. 7.0.3
  3. It's crucial that this results in duplicated versions of different Storybook packages, which is why this is tricky in the monorepo given the portaled resolutions which are used.
  4. Run Storybook build

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/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>

@yannbf yannbf added bug patch:yes Bugfix & documentation PR that need to be picked to main branch core ci:normal labels Nov 16, 2023
Copy link
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

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

Haven't tried it out, but the code looks good!

@yannbf yannbf self-assigned this Nov 20, 2023
@yannbf yannbf force-pushed the yann/add-no-matching-export-error branch from 0e0dbf4 to f5dba08 Compare November 21, 2023 14:56
@yannbf yannbf force-pushed the yann/add-no-matching-export-error branch from f5dba08 to f0fd10b Compare November 22, 2023 07:58
@yannbf yannbf merged commit 87778f8 into next Nov 22, 2023
60 checks passed
@yannbf yannbf deleted the yann/add-no-matching-export-error branch November 22, 2023 08:39
@JReinhold JReinhold added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal core 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]: No matching export in "global-externals:@storybook/channels" for import "createBrowserChannel"
3 participants