Skip to content

Conversation

@selenehyun
Copy link
Contributor

@selenehyun selenehyun commented Jul 30, 2025

Closes #

What I did

Updated the migration guide URL in cli-storybook’s upgrade.ts.
The previous link:

https://storybook.js.org/docs/migration-guide
2025-07-30 at 10 42 22@2x

has been corrected to:

https://storybook.js.org/docs/releases/migration-guide
2025-07-30 at 10 42 48@2x

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:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

No manual testing is required for this change.
Optionally, you may run the upgrade command and verify that the log displays the updated URL.

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update MIGRATION.MD

No documentation updates are needed as this only corrects a URL.

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make 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.ts file from https://storybook.js.org/docs/migration-guide to https://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 running storybook 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 logUpgradeResults function, 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

  • This is an extremely safe change that only corrects a documentation URL in a logging message.
  • The fix addresses a clear user-facing issue (broken link) with a straightforward solution.
  • No files need additional attention as this is a simple URL correction with no functional impact.

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)

Copy link
Contributor

@greptile-apps greptile-apps bot left a 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

Edit Code Review Bot Settings | Greptile

@yannbf yannbf changed the title fix: fixed broken migration guide link Documents: Fixed broken migration guide link Aug 4, 2025
@storybook-app-bot
Copy link

storybook-app-bot bot commented Aug 5, 2025

Package Benchmarks

Commit: 404c4f3, ran on 5 August 2025 at 15:29:21 UTC

No significant changes detected, all good. 👏

@jonniebigodes jonniebigodes changed the title Documents: Fixed broken migration guide link CLI: Fixed broken migration guide link Aug 5, 2025
Copy link
Contributor

@jonniebigodes jonniebigodes left a 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

@nx-cloud
Copy link

nx-cloud bot commented Aug 5, 2025

View your CI Pipeline Execution ↗ for commit 404c4f3

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 12s View ↗

☁️ Nx Cloud last updated this comment at 2025-08-05 16:45:03 UTC

@jonniebigodes jonniebigodes merged commit 94ef419 into storybookjs:next Aug 5, 2025
50 checks passed
@github-actions github-actions bot mentioned this pull request Aug 5, 2025
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants