Skip to content

Docs: Enhance upgrading guide#31744

Merged
valentinpalkovic merged 11 commits into
nextfrom
valentin/revamp-upgrade-documentation
Jun 16, 2025
Merged

Docs: Enhance upgrading guide#31744
valentinpalkovic merged 11 commits into
nextfrom
valentin/revamp-upgrade-documentation

Conversation

@valentinpalkovic
Copy link
Copy Markdown
Contributor

@valentinpalkovic valentinpalkovic commented Jun 11, 2025

Closes #

What I did

Enhance the upgrading guide with mono-repository support and automatic health check features

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

Comprehensive enhancement of the upgrading documentation, adding detailed sections on mono-repository support and automated health checks.

  • Added documentation for mono-repository support including environment variables for limiting upgrade scope
  • Introduced new doctor command documentation for automated health checks and troubleshooting
  • Enhanced version upgrade guidance with clear warnings about major version transitions
  • Added Vue 2 EOL considerations and migration path recommendations
  • Improved structure and readability of upgrade process documentation with clear step-by-step instructions

@valentinpalkovic valentinpalkovic self-assigned this Jun 11, 2025
@valentinpalkovic valentinpalkovic added documentation ci:docs Run the CI jobs for documentation checks only. labels Jun 11, 2025
@valentinpalkovic valentinpalkovic marked this pull request as ready for review June 11, 2025 09:05
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.

1 file reviewed, 1 comment
Edit PR Review Bot Settings | Greptile

Comment thread docs/configure/upgrading.mdx
Comment thread docs/configure/upgrading.mdx Outdated
Comment thread docs/configure/upgrading.mdx Outdated
Co-authored-by: Yann Braga <yannbf@gmail.com>
Comment thread docs/configure/upgrading.mdx Outdated
Comment thread docs/configure/upgrading.mdx Outdated
Comment thread docs/configure/upgrading.mdx Outdated
@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Jun 11, 2025

View your CI Pipeline Execution ↗ for commit 6e1fac0.

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

☁️ Nx Cloud last updated this comment at 2025-06-12 21:30:25 UTC

valentinpalkovic and others added 8 commits June 11, 2025 11:12
Co-authored-by: Yann Braga <yannbf@gmail.com>
Co-authored-by: Yann Braga <yannbf@gmail.com>
* next: (39 commits)
  Update CHANGELOG.md for v9.0.9 [skip ci]
  fix scripts test
  Next.js: Add styled-jsx to optimize Vite dependencies in configuration
  Next.js: Update styled-jsx resolution method in Vite configuration
  Prevent destructuring of undefined
  Next.js: Enhance Vite configuration with styled-jsx aliasing
  Next.js: Add webpack alias to resolve Next.js package conflicts
  dont at-mention users in release PR descriptions
  cleanup, fix unit tests
  Angular: Update MiniCssExtractPlugin configuration for cache busting
  remove unneeded preview entrypoints for core addons
  relatively import preview annotations of core addons
  Refactor import statements in find-implicit-spies.ts to consolidate Babel imports
  Update dependencies in yarn.lock and package.json
  use babel from core in codemods
  bundle in giget
  Bump version from "9.1.0-alpha.5" to "9.1.0-alpha.6" [skip ci]
  prebundle more in cli-storybook package
  Write changelog for 9.1.0-alpha.6 [skip ci]
  fix package manager instance in empty dir flow
  ...
@kylegach kylegach added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jun 12, 2025
Copy link
Copy Markdown
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.

@valentinpalkovic, thanks for putting together this pull request and helping improve the documentation. I appreciate it 🙏 ! I left one item for you to consider when you can.
Approving to unblock you

Comment on lines +101 to +112
| Flag | Description |
| -------------------------------- | ------------------------------------------------------------------------------------------ |
| `-c, --config-dir <dir-name...>` | Directory or directories to find Storybook configurations |
| `--debug` | Enable more logs for debugging (default: false) |
| `--disable-telemetry` | Disable sending telemetry data |
| `--enable-crash-reports` | Enable sending crash reports to telemetry data |
| `-f, --force` | Force the upgrade, skipping autoblockers |
| `--loglevel <level>` | Define log level: `debug`, `error`, `info`, `silent`, `trace`, or `warn` (default: `info`) |
| `--package-manager <manager>` | Force package manager: `npm`, `pnpm`, `yarn1`, `yarn2`, or `bun` |
| `-s, --skip-check` | Skip postinstall version and automigration checks |
| `--write-logs` | Write all debug logs to a file at the end of the run |
| `-y, --yes` | Skip prompting the user |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@valentinpalkovic, when you can, adjust the upgrade options in the CLI documentation with the new ones (e.g., --write-logs and --loglevel <level>) so that we don't introduce misconceptions in the documentation

@valentinpalkovic valentinpalkovic merged commit d6e6437 into next Jun 16, 2025
8 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/revamp-upgrade-documentation branch June 16, 2025 06:40
@valentinpalkovic valentinpalkovic added patch:yes Bugfix & documentation PR that need to be picked to main branch and removed patch:yes Bugfix & documentation PR that need to be picked to main branch labels Jun 16, 2025
@github-actions github-actions Bot mentioned this pull request Jun 17, 2025
15 tasks
valentinpalkovic added a commit that referenced this pull request Jun 18, 2025
…cumentation

Docs: Enhance upgrading guide
(cherry picked from commit d6e6437)
@github-actions github-actions Bot mentioned this pull request Jun 18, 2025
15 tasks
@github-actions github-actions Bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jun 18, 2025
@ndelangen ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants