CLI: Fix existing version detection in upgrade
#25642
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
ndelangen
reviewed
Jan 18, 2024
Comment on lines
+31
to
+34
| // Note that this probably doesn't work in Yarn PNP mode because @storybook/telemetry doesn't depend on @storybook/cli | ||
| export const getStorybookCoreVersion = async () => { | ||
| const coreVersions = await Promise.all( | ||
| ['@storybook/core-common', '@storybook/core-server'].map(getActualPackageVersion) | ||
| ); | ||
| return coreVersions.find((v) => v.version)?.version; | ||
| const { version } = await getActualPackageVersion('@storybook/cli'); | ||
| return version; |
There was a problem hiding this comment.
can we add a backup in that case?
There was a problem hiding this comment.
I'm not sure how? Presumably you can't require.resolve anything in PnP mode, because you're running with npx so you don't depend on anything in the project, and thus you can't resolve it.
There was a problem hiding this comment.
To be clear, this didn't work before either in PnP, it never worked. Confirmed on a call that we're then OK to merge.
shilman
approved these changes
Jan 18, 2024
storybook-bot
pushed a commit
that referenced
this pull request
Jan 18, 2024
CLI: Fix existing version detection in `upgrade` (cherry picked from commit 81db91d)
This was referenced Jan 18, 2024
Merged
storybook-bot
pushed a commit
that referenced
this pull request
Jan 18, 2024
CLI: Fix existing version detection in `upgrade` (cherry picked from commit 81db91d)
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.
Works on #25293
What I did
This PR changes the code that detects the existing version installed to use
@storybook/cliinstead of@storybook/core-commonor@storybook/core-server. This is because many packages depends on@storybook/core-commonand sometimes a project can get into a state where multiple versions of that package exists. This could cause the upgrade to fail withSB_CLI_UPGRADE_0004 (UpgradeStorybookToSameVersionError). Using the version of@storybook/cliinstead is safer because it will only be in the project once since no other packages depend on it.I tested this with the canary version in both npm, pnpm, Yarn 4 and Yarn PnP and it worked everywhere. Yarn PnP expectedly did not find a version, so I've added a fallback version. It's not the best user experience to see "You're upgrading from 0.0.0" but this is just a quick fix in the interest of time.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
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-25642-sha-bb79636f. Try it out in a new sandbox by runningnpx storybook@0.0.0-pr-25642-sha-bb79636f sandboxor in an existing project withnpx storybook@0.0.0-pr-25642-sha-bb79636f upgrade.More information
0.0.0-pr-25642-sha-bb79636fjeppe/fix-version-detectionbb79636f1705566811)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=25642