CLI: Improve Storybook packages version management #11342
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
gaetanmaisse
force-pushed
the
tech/improve-versions-management-in-cli
branch
3 times, most recently
from
760a39b
to
d9976cf
Compare
gaetanmaisse
force-pushed
the
tech/improve-versions-management-in-cli
branch
3 times, most recently
from
0611769
to
75cfc53
Compare
gaetanmaisse
requested review from
ndelangen,
shilman and
stijnkoopal
as code owners
gaetanmaisse
commented
Jul 7, 2020
Comment on lines
+35
to
+38
| "prepare": "node ../../scripts/prepare.js && node -r esm ./scripts/generate-sb-packages-versions.js", | ||
| "test": "cd test && ./run_tests.sh", | ||
| "test-yarn-2": "cd test && ./run_tests_yarn_2.sh", | ||
| "postversion": "node -r esm ./scripts/generate-app-versions.js" | ||
| "postversion": "node -r esm ./scripts/generate-sb-packages-versions.js" |
There was a problem hiding this comment.
@shilman can you confirm that with these 2 lines, versions.json will be recreated during the release process (after the version bump) and then committed to the repo?
…ckages The previous script was only extracting version for packages under `app` directory. Now, all `@storybook` packages are processed and save with their current version in the monorepo in `versions.json`. This file will be use to find out which version of the packages should be installed when running `sb init`.
Previously it used `devDep` of `package.json`. It was working but doing so all Storybook packages had to be added to `devDep`. Moreover, as `@storybook/react-native` was not part of the monorepo anymore it's version was stuck to `6.0.0-alpha.0` causing a download of `6.0.0-alpha.0` SB packages when running `yarn install`.
These deps were only there to help to find out which version should be installed when using the CLI. This is now done with a dedicated `versions.json` file not theya re not needed in `package.json` anymore. Bonus: it removes some `6.0.0-alpha.0` SB packages that were required by `"@storybook/react-native": "6.0.0-alpha.0"`
`@babel/plugin-transform-react-jsx` should be resolved in the context of `addon-docs` and not in the one of SB user projects (as it's done for the others loaders too). The goal of that is to ensure we are using a deps that is properly declared either as dep or peerDep
gaetanmaisse
force-pushed
the
tech/improve-versions-management-in-cli
branch
3 times, most recently
from
531b8cf
to
44348e8
Compare
Closed
…n 2 out of the box
CLI now generates project with `addon-essential` so it enable `addon-viewport` by default. I added a simple test to check that viewport is properly loaded: - Go to Welcome Story - Click on Viewport button in the toolbar - Select "Small Mobile" - Check that Welcome Story is still displayed
gaetanmaisse
force-pushed
the
tech/improve-versions-management-in-cli
branch
from
44348e8
to
3e13343
Compare
|
I discussed a bit with @shilman about mdx and tried to make |
shilman
approved these changes
Jul 12, 2020
|
@shilman can I merge this PR or should I wait as we are now in RC? |
shilman
changed the title
shilman
changed the title
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.
What I did
♻️ Refactor script to extract and save versions of all SB packages:
The previous script was only extracting version for packages under
appdirectory. Now, all@storybookpackages are processed and save with their current version in the monorepo inversions.json. This file will be used to find out which version of the packages should be installed when runningsb init.🆕 Use
versions.jsonto get SB packages versions🗑️ Remove all Storybook packages listed as
devDeps:These deps were only there to help to find out which version should be installed when using the CLI. This is now done with a dedicated
versions.jsonfile so they are not needed inpackage.jsonanymore.Bonus: it removes some
6.0.0-alpha.0SB packages that were required by"@storybook/react-native": "6.0.0-alpha.0"➕ Add some dependencies to be able to run
addon-docswith Yarn 2 out of the box:@storybook/addon-docsis needed as a 1st level dep as we are importing things from@storybook/addon-docs/blocksin mdx stories.@mdx-js/react, SB won't deal with mdx file without adding this dep (so this is a temporary work-around). I need to discuss with you @shilman to deeply understand how mdx stories are working.🤖 CLI now generates projects with
addon-essentialso it enablesaddon-viewportby default. I added a simple test to check that viewport is properly loaded:How to test