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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Core: Disable Docs DLL by default #12874

Merged
merged 1 commit into from
Oct 23, 2020
Merged

Core: Disable Docs DLL by default #12874

merged 1 commit into from
Oct 23, 2020

Conversation

shilman
Copy link
Member

@shilman shilman commented Oct 23, 2020

Issue: #12408 #10982 #12016

What I did

Storybook 6.0 has two Webpack DLLs: the UI DLL that runs in the manager, the Docs DLL that runs in the preview with user code. This PR disables the Docs DLL by default because it's causing lots of version conflicts, e.g. React 17, core-js, etc. in exchange for some performance improvements.

This PR disables the docs DLL by default since the current out of box experience for Storybook is broken now that React 17 has landed.

There are a few implications:

  1. Startup time for the preview will be marginally slower if you use addon-docs. We'll be working hard to get this perf back in other ways.
  2. Because the Docs DLL screws up with dependency resolution, it's possible that you were using a different version of a library that you weren't expecting, and this change

This is technically a breaking change, but if you want to restore the old behavior you can run start-storybook or build-storybook with the --docs-dll flag to restore the old behavior.

Soon in 6.1 we will attempt to remove all DLLs entirely #12637 and will be working to fix the corresponding performance issues in other ways.

How to test

TBD

@shilman shilman added bug patch:yes Bugfix & documentation PR that need to be picked to main branch core addon: docs labels Oct 23, 2020
Copy link
Contributor

@tooppaaa tooppaaa left a comment

Choose a reason for hiding this comment

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

🚀 All good !

@shilman shilman merged commit 9bfed40 into next Oct 23, 2020
@shilman shilman deleted the 12408-disable-docs-dll branch October 23, 2020 07:18
@tmeasday
Copy link
Member

👏 well played

@shilman shilman added the patch:done Patch/release PRs already cherry-picked to main/release branch label Oct 23, 2020
shilman added a commit that referenced this pull request Oct 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs bug 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.

4 participants