Skip to content
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

Migration: Document dropped support legacy packages #30766

Open
wants to merge 3 commits into
base: norbert/automigrate-cpc-complaince
Choose a base branch
from

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Mar 6, 2025

What I did

Update MIGRATION.md to detail package consolidation and import changes for Storybook 9.0.0, including:

  • List of packages moved to internal paths
  • Instructions for package uninstallation and import updates
  • Guidance for addon authors on internal package usage

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>

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 79.9 MB 79.9 MB 0 B 0.49 0%
initSize 79.9 MB 79.9 MB 0 B 0.49 0%
diffSize 97 B 97 B 0 B - 0%
buildSize 7.47 MB 7.47 MB 0 B -2 0%
buildSbAddonsSize 1.98 MB 1.98 MB 0 B -2 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 1.88 MB 1.88 MB 0 B - 0%
buildSbPreviewSize 0 B 0 B 0 B - -
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 4.06 MB 4.06 MB 0 B -2 0%
buildPreviewSize 3.42 MB 3.42 MB 0 B -2 0%
testBuildSize 0 B 0 B 0 B - -
testBuildSbAddonsSize 0 B 0 B 0 B - -
testBuildSbCommonSize 0 B 0 B 0 B - -
testBuildSbManagerSize 0 B 0 B 0 B - -
testBuildSbPreviewSize 0 B 0 B 0 B - -
testBuildStaticSize 0 B 0 B 0 B - -
testBuildPrebuildSize 0 B 0 B 0 B - -
testBuildPreviewSize 0 B 0 B 0 B - -
name before after diff z %
createTime 7.9s 28.9s 20.9s 1.18 72.6%
generateTime 21.1s 18.5s -2s -685ms -0.87 -14.5%
initTime 4.7s 4.3s -406ms -0.84 -9.4%
buildTime 8.9s 8.4s -515ms -0.96 -6.1%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 4.6s 4.7s 54ms -1.1 1.1%
devManagerResponsive 4.4s 4.5s 59ms -1.12 1.3%
devManagerHeaderVisible 663ms 700ms 37ms -1.19 5.3%
devManagerIndexVisible 672ms 706ms 34ms -1.21 4.8%
devStoryVisibleUncached 2.3s 2.6s 277ms 0.12 10.6%
devStoryVisible 1.1s 1.2s 122ms -0.49 10%
devAutodocsVisible 1s 1s 70ms -0.78 6.4%
devMDXVisible 1.1s 1s -44ms -0.91 -4.1%
buildManagerHeaderVisible 643ms 680ms 37ms -1.31 🔺5.4%
buildManagerIndexVisible 645ms 685ms 40ms -1.25 🔺5.8%
buildStoryVisible 638ms 667ms 29ms -1.33 4.3%
buildAutodocsVisible 612ms 630ms 18ms -1.41 2.9%
buildMDXVisible 546ms 529ms -17ms -1.73 -3.2%

Greptile Summary

Updates MIGRATION.md to document package consolidation changes for Storybook 9.0, focusing on internal package reorganization and import path updates.

  • Added section detailing packages moved to @storybook/internal/* paths
  • Added guidance for uninstalling legacy packages and updating imports
  • Added instructions for addon authors on handling internal package usage
  • Added note about backwards compatibility in 9.0 and potential removal in 10.0
  • Added clear migration steps for transitioning from standalone packages to consolidated structure

…9.0.0

Update MIGRATION.md to detail package consolidation and import changes for Storybook 9.0.0, including:
- List of packages moved to internal paths
- Instructions for package uninstallation and import updates
- Guidance for addon authors on internal package usage
@ndelangen ndelangen changed the title Migration: Document dropped support for legacy Storybook packages in 9.0.0 Migration: Document dropped support legacy packages Mar 6, 2025
Copy link

nx-cloud bot commented Mar 6, 2025

View your CI Pipeline Execution ↗ for commit 46e4387.

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

☁️ Nx Cloud last updated this comment at 2025-03-07 14:55:15 UTC

@ndelangen ndelangen self-assigned this Mar 6, 2025
@ndelangen ndelangen marked this pull request as ready for review March 6, 2025 15:58
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(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile

ndelangen and others added 2 commits March 7, 2025 11:12
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Comment on lines +447 to +449
| @storybook/manager-api | storybook/internal/manager-api |
| @storybook/preview-api | storybook/internal/preview-api |
| @storybook/theming | storybook/internal/theming |
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
| @storybook/manager-api | storybook/internal/manager-api |
| @storybook/preview-api | storybook/internal/preview-api |
| @storybook/theming | storybook/internal/theming |
| @storybook/manager-api | storybook/manager-api |
| @storybook/preview-api | storybook/preview-api |
| @storybook/theming | storybook/theming |

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.

2 participants