CLI: Fix upgrade detecting the wrong version of existing Storybooks
#25752
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
JReinhold
requested review from
shilman,
yannbf,
ndelangen and
valentinpalkovic
as code owners
JReinhold
commented
Jan 26, 2024
Comment on lines
-32
to
-35
| export const getStorybookCoreVersion = async () => { | ||
| const { version } = await getActualPackageVersion('@storybook/cli'); | ||
| return version; | ||
| }; |
There was a problem hiding this comment.
@shilman this is a function in telemetry but it was only used by upgrade which doesn't use it anymore, so I felt it was okay to remove it. Let me know if not.
ndelangen
approved these changes
Jan 26, 2024
| if (!installations) { | ||
| return; | ||
| } | ||
| const cliVersion = installations.dependencies['@storybook/cli']?.[0].version; |
There was a problem hiding this comment.
installations.dependencies['@storybook/cli']?.[0] -> Can this be undefined? If so installations.dependencies['@storybook/cli']?.[0].version will through.
There was a problem hiding this comment.
It can't, TS would complain, and the current code producing it doesn't do that either.
…ybookjs/storybook into jeppe/fix-upgrade-version-detection
yannbf
approved these changes
Jan 26, 2024
11 tasks
JReinhold
added
the
patch:yes
This was referenced Jan 30, 2024
Merged
Merged
JReinhold
added a commit
that referenced
this pull request
Jan 31, 2024
…detection CLI: Fix `upgrade` detecting the wrong version of existing Storybooks (cherry picked from commit 7c21c34)
github-actions
bot
added
the
patch:done
8 tasks
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.
Closes #25734
What I did
Changed the
upgradecommand to use package manager's CLI for detecting the existing version of bothstorybookand@storybook/cliinstead of using a combination ofrequire.resolveand readingpackage.json, as that would run in the global context thus not detecting the correct version as it is in the project. ThepackageManager.findInstallationsfunction being used was originally develop for thedoctorcommand but it works fine in this context too.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This can be (and has been) tested with the canary release and using the different package manager executors. Eg. in a 7.6.10 sandbox/project, running this should result in the message Upgrading Storybook from version 7.6.10 to version 0.0.0-pr-25752-sha-424630b7..
npx storybook@0.0.0-pr-25752-sha-424630b7 upgradeyarn dlx storybook@0.0.0-pr-25752-sha-424630b7 upgradepnpm dlx storybook@0.0.0-pr-25752-sha-424630b7 upgradepnpx storybook@0.0.0-pr-25752-sha-424630b7 upgradeDocumentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake 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 pull request has been released as version
0.0.0-pr-25752-sha-424630b7. Try it out in a new sandbox by runningnpx storybook@0.0.0-pr-25752-sha-424630b7 sandboxor in an existing project withnpx storybook@0.0.0-pr-25752-sha-424630b7 upgrade.More information
0.0.0-pr-25752-sha-424630b7jeppe/fix-upgrade-version-detection424630b71706261623)To request a new release of this pull request, mention the
@storybookjs/coreteam.core team members can create a new canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=25752