Skip to content

CLI: Fix Docs migration link in migrations#32196

Merged
yannbf merged 1 commit into
nextfrom
cli_fix_migration_link
Aug 6, 2025
Merged

CLI: Fix Docs migration link in migrations#32196
yannbf merged 1 commit into
nextfrom
cli_fix_migration_link

Conversation

@jonniebigodes
Copy link
Copy Markdown
Contributor

@jonniebigodes jonniebigodes commented Aug 5, 2025

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:

  • Updated the link in the migration summary and also the tests

@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:

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

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

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

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 have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team 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-guide to https://storybook.js.org/docs/releases/migration-guide in 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

  • This PR is safe to merge with minimal risk as it only updates a URL string
  • Score reflects the straightforward nature of fixing a broken link with no logic changes
  • No files require special attention as the changes are simple URL updates

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)

@jonniebigodes jonniebigodes requested a review from yannbf August 5, 2025 16:59
@jonniebigodes jonniebigodes changed the title CLI: FIx Docs migration link CLI: Fix Docs migration link in migrations Aug 5, 2025
Copy link
Copy Markdown
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.

2 files reviewed, no comments

Edit Code Review Bot Settings | Greptile

@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Aug 5, 2025

View your CI Pipeline Execution ↗ for commit 479765e

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

☁️ Nx Cloud last updated this comment at 2025-08-05 17:23:29 UTC

Copy link
Copy Markdown
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@yannbf yannbf merged commit ead67db into next Aug 6, 2025
57 of 58 checks passed
@yannbf yannbf deleted the cli_fix_migration_link branch August 6, 2025 07:58
@github-actions github-actions Bot mentioned this pull request Aug 6, 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