CLI: Refactor to add autoblockers #25934
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
changed the title
This comment was marked as resolved.
This comment was marked as resolved.
… we get the required context to pass in
… the user has a vite config file with the right plugins in there
Co-authored-by: Valentin Palkovic <valentin@chromatic.com>
Co-authored-by: Valentin Palkovic <valentin@chromatic.com>
…orybookjs/storybook into norbert/upgrade-auto-blockers
valentinpalkovic
approved these changes
Feb 13, 2024
13 tasks
JReinhold
reviewed
Feb 15, 2024
| export const viteConfigFile = { | ||
| id: 'viteConfigFile', | ||
|
|
||
| async check({ mainConfig, packageManager }) { |
There was a problem hiding this comment.
I don't see any handling of custom vite config locations, was that a deliberate decision?
https://storybook.js.org/docs/builders/vite#override-the-default-configuration
There was a problem hiding this comment.
Good point! I think this was just missed. @ndelangen, Can you put together a follow-up PR?
There was a problem hiding this comment.
Was missed indeed. I didn't know this was an option.
ndelangen
added a commit
that referenced
this pull request
Feb 19, 2024
8 tasks
usrrname
pushed a commit
to usrrname/storybook
that referenced
this pull request
Mar 9, 2024
usrrname
pushed a commit
to usrrname/storybook
that referenced
this pull request
Mar 9, 2024
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 #25911
Closes #25453
What I did
A good example: vue2 support.
We stopped supporting this in sb8 and so we block those users from upgrading to sb8
A bad example: vite3 support
We stopped supporting vite3 in sb8, but making it an autoblocker would mean users have to upgrade vite first, which may not be possible, because the old version of storybook would prevent them. It's a chicken/egg problem really.
So instead we let the user upgrade, and then in an automigration tell them to upgrade vite.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Try to upgrade a project that still uses vue2, it should tell you to migrate to vue3
Try to upgrade a project that has
storyStoreV7:false, it should tell you to remove that flagTry to migrate whilst having
*.stories.mdxsomewhere in your project, it should tell you to run codemodsIf you have none of the above, autoblockers should not block you from upgrading
upgrading a project that uses vite v3 should ask you if you want to upgrade to the latest version of vite, and if you answer yes, should do that for you.
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-25934-sha-a4d40871. Try it out in a new sandbox by runningnpx storybook@0.0.0-pr-25934-sha-a4d40871 sandboxor in an existing project withnpx storybook@0.0.0-pr-25934-sha-a4d40871 upgrade.More information
0.0.0-pr-25934-sha-a4d40871norbert/upgrade-auto-blockersa4d408711707809156)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=25934