feat(storybook): upgrade to v7 #8342
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jtoar
commented
May 17, 2023
| builder: 'webpack5', | ||
| framework: { | ||
| name: '@storybook/react-webpack5', | ||
| options: {}, |
There was a problem hiding this comment.
This empty object is actually necessary:
jtoar
commented
May 17, 2023
jtoar
commented
May 19, 2023
Comment on lines
-32
to
-41
| // Storybook's UI uses a separate Webpack configuration | ||
| managerWebpack: (sbConfig) => { | ||
| const userManagerPath = fs.existsSync(rwjsPaths.web.storybookManagerConfig) | ||
| ? rwjsPaths.web.storybookManagerConfig | ||
| : './manager.example.js' | ||
| sbConfig.resolve.alias['~__REDWOOD__USER_STORYBOOK_MANAGER_CONFIG'] = | ||
| userManagerPath | ||
|
|
||
| return sbConfig | ||
| }, |
There was a problem hiding this comment.
The ability to configure the manager is gone and is the most obvious breaking change
jtoar
commented
May 20, 2023
Comment on lines
+38
to
+41
| // Only set staticDirs when running Storybook process; will fail if set for SB --build | ||
| ...(process.env.NODE_ENV !== 'production' && { | ||
| staticDirs: [path.join(redwoodProjectPaths.web.base, 'public')], | ||
| }), |
There was a problem hiding this comment.
I moved this up because it gets lost under webpackFinal
jtoar
commented
May 20, 2023
| @@ -27,6 +27,7 @@ | |||
| "postcss": "^8.4.23", | |||
| "postcss-loader": "^7.3.0", | |||
| "prettier-plugin-tailwindcss": "^0.2.8", | |||
| "storybook": "7.0.12", | |||
There was a problem hiding this comment.
I need this here to get tests to run correctly; we can remove it after a canary gets published
jtoar
commented
May 20, 2023
Comment on lines
+6
to
+10
| timeout: 90_000 * 3, | ||
| expect: { | ||
| timeout: 10 * 1000, | ||
| }, | ||
| workers: 1, // do not run things in parallel |
There was a problem hiding this comment.
I could experiment with these settings more, but so far I had to increase the timeout and borrow the strategy used in the Vite PR to get the smoke tests to pass
jtoar
commented
May 24, 2023
There was a problem hiding this comment.
Got the go ahead from @thedavidprice; merging so we can work on the next steps
|
Great to see this one in 🎉 |
jtoar
added a commit
that referenced
this pull request
Jul 1, 2023
Follow up to #8342. Storybook removed the ability to configure the manager (see https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#no-more-configuration-for-manager). Let's remove this section from the docs as it's no longer true: https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#no-more-configuration-for-manager
jtoar
added a commit
that referenced
this pull request
Jul 1, 2023
Follow up to #8342. Storybook removed the ability to configure the manager (see https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#no-more-configuration-for-manager). Let's remove this section from the docs as it's no longer true: https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#no-more-configuration-for-manager
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I got Storybook v7 to start with these changes. To test:
storybookto the web side (this won't be necessary when this PR is merged and@redwoodjs/testingis published with these changes):yarn rwfw project:sync,yarn rw sb(make sure you have stories)Working notes:
start-storybook->storybook dev;build-storybook->storybook buildit seems like: https://github.com/storybookjs/storybook/blob/57b86e62c4c20edf68ec5e778d4775e9e07147f1/docs/configure/storybook-addons.md?plain=1#L23@storybook/addon-essentialsis included by default now@storybook/cli. not sure if there's any reason to prefer one over the other. doesn't seem like there isThe following aren't necessary for this PR, but are just points to explore for the future:
yarn rw storybookon v7 seems slowerstorybook.config.js). we should consider renaming it@storybook/addon-docs, but we don't use it. maybe we just consider it important enough to include by default but I'd like to know for surewebpackFinal