CLI: Fix Docs migration link in migrations#32196
Merged
Merged
Conversation
|
View your CI Pipeline Execution ↗ for commit 479765e
☁️ Nx Cloud last updated this comment at |
4 tasks
yannbf
approved these changes
Aug 6, 2025
This file contains hidden or 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
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.
Follows up on:
What I did
With this pull request the CLI, specifically the migration links, were updated to prevent them from 404ing as a result of #31662 getting merged and published
What was done:
@yannbf, I tagged you in this because you've been working a bit on the CLI and migrations and have some context on it. Let me know your feedback, and we'll go from there.
Thanks in advance
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 fixes a broken documentation link in the Storybook CLI that was causing 404 errors for users after running automigrations. The change updates the migration guide URL from
https://storybook.js.org/docs/migration-guidetohttps://storybook.js.org/docs/releases/migration-guidein both the CLI output message and corresponding test snapshots.The fix addresses a user experience issue where the CLI's migration summary was directing users to a non-existent page. This follows from a documentation restructuring (referenced in issues #32148 and #31662) where migration guides were moved under the
/docs/releases/path. The change is limited to two files: the main migration summary helper that generates the CLI output message, and its test file that validates the expected output format.This is a straightforward URL update that ensures users can access the migration documentation they need after upgrading Storybook versions. The change maintains the existing functionality while correcting the link destination to point to the valid location of the migration guide.
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)