Skip to content

Documentation: Migration note on removal addon-essentials #30995

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

Merged
merged 4 commits into from
Apr 16, 2025

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Mar 31, 2025

What I did

This pull request includes several updates to the MIGRATION.md file, mainly focusing on the removal of deprecated items, updates to the addon essentials, and various formatting corrections. The most important changes are summarized below:

Addon Essentials

  • Added a new section explaining the removal of @storybook/addon-essentials and instructions for users on how to manually add @storybook/addon-docs if needed.

Deprecated Items and Updates

  • Removed the entry for "Docs addon moved out of addon-essentials" from the migration guide. [1] [2]
  • Corrected the formatting of several section headers and list items to ensure proper rendering and readability. [1] [2] [3]
  • Added missing blank lines after list items to maintain consistent formatting. [1] [2] [3] [4] [5] [6] [7] [8] [9]

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 refines the MIGRATION.md file for Storybook 9.0 by adding a dedicated section on the removal of @storybook/addon-essentials and improving formatting.

  • Updated MIGRATION.md with clear instructions to manually add @storybook/addon-docs if needed.
  • Removed obsolete documentation regarding the docs addon transition from addon-essentials.
  • Improved formatting with correct blank lines and header adjustments for enhanced readability.

…addon-essentials` and clarify changes in package manager support. Adjusted formatting for consistency and improved clarity on deprecated features and required updates for users.
@ndelangen ndelangen self-assigned this Mar 31, 2025
@ndelangen ndelangen added documentation ci:docs Run the CI jobs for documentation checks only. labels Mar 31, 2025
@ndelangen ndelangen marked this pull request as ready for review March 31, 2025 10:19
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the migration documentation for Storybook 9.0. It introduces a new section detailing the removal of addon-essentials, updates import paths, and refines formatting for improved clarity and consistency.

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.

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

MIGRATION.md Outdated
Comment on lines 918 to 920
<h1>Migration</h1>
### Addon-a11y: Replaced experimental `ally-test` tag behavior with `parameters.a11y.test`

- [From version 8.x to 9.0.0](#from-version-8x-to-900)
Copy link
Member Author

Choose a reason for hiding this comment

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

I caught this regression in this PR of mine:
#30909

So this is bringing back the correct content @valentinpalkovic

Copy link

nx-cloud bot commented Mar 31, 2025

View your CI Pipeline Execution ↗ for commit 8bb4dad.

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

☁️ Nx Cloud last updated this comment at 2025-04-16 13:48:27 UTC

@ndelangen ndelangen merged commit fd5928f into next Apr 16, 2025
8 checks passed
@ndelangen ndelangen deleted the norbert/migration-addon-essentials branch April 16, 2025 13:53
@github-actions github-actions bot mentioned this pull request Apr 16, 2025
18 tasks
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants