Maintenance: Add flag to toggle default automigrations #32113
Merged
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 #
What I did
When running via

storybook upgrade, the automigration is deselectedWhen running via

storybook automigrate, "No" is selectedAdditionally I set clack as prompt library for

storybook automigrate:otherwise it looks really bad

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-storybook/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 PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
This PR introduces a new
defaultSelectedproperty to the automigration system to provide more granular control over which automigrations are pre-selected when users run Storybook upgrade commands.The key changes include:
promptDefaultValueproperty with the more intuitivedefaultSelectedproperty across the automigration systemstorybook upgrade, automigrations are now deselected by default, whilestorybook automigratedefaults to "No" - giving users more control over potentially disruptive changesdefaultSelected: false(as demonstrated in theupgrade-storybook-related-dependenciesfix)picocolorsimports from several automigration fix filesThe change integrates with Storybook's existing automigration infrastructure by updating the
BaseFixtype definition, modifying the prompt logic in both single-project and multi-project scenarios, and maintaining backward compatibility by defaulting totruewhen the property is not specified. This allows the system to distinguish between different upgrade contexts and provide appropriate default behaviors for each.Confidence score: 4/5