-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
CLI: Fixed broken migration guide link #32148
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CLI: Fixed broken migration guide link #32148
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 file reviewed, no comments
Package BenchmarksCommit: No significant changes detected, all good. 👏 |
jonniebigodes
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@selenehyun, thank you for putting together this pull request and helping us fix this issue with the link in the CLI. Appreciate it 🙏 ! I've checked, and all is good on my end.
More than glad to merge this once the checklist clears.
Hope you have a fantastic day.
Stay safe
|
View your CI Pipeline Execution ↗ for commit 404c4f3
☁️ Nx Cloud last updated this comment at |
Closes #
What I did
Updated the migration guide URL in
cli-storybook’supgrade.ts.The previous link:
has been corrected to:
This ensures users are directed to the correct migration guide after running the upgrade.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
No manual testing is required for this change.
Optionally, you may run the
upgradecommand and verify that the log displays the updated URL.Documentation
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 require a canary release.
Greptile Summary
This PR fixes a broken documentation link in the Storybook CLI upgrade command. The change updates a single URL reference in the
upgrade.tsfile fromhttps://storybook.js.org/docs/migration-guidetohttps://storybook.js.org/docs/releases/migration-guide. This URL appears in the post-upgrade logging message that directs users to the migration guide for understanding changes after runningstorybook upgrade.The fix addresses a user experience issue where the upgrade command was displaying a broken link (404 error) instead of directing users to the correct migration documentation. This logging occurs in the
logUpgradeResultsfunction, which provides helpful resources to users after they complete a Storybook upgrade. The corrected URL ensures users can access the migration guide documentation to understand the changes and steps needed for their upgrade.Confidence score: 5/5
Context used:
Context - In the documentation, ensure that the links to the builder's documentation and the Next.js framework documentation are correct and not broken. (link)