Skip to content

Conversation

@ndelangen
Copy link
Member

@ndelangen ndelangen commented Jun 10, 2025

What I did

I've removed the re-export of ./blocks from the addon docs main entrypoint.

Users should be importing blocks from @storybook/addon-docs/blocks and not from the main entrypoint of addon-docs.

The reason this came up, was because of the fast build feature broke due to a user importing a block from addon-docs main entrypoint.

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

Breaking change that removes block exports from addon-docs main entrypoint to fix fast build feature compatibility issues. Users must now import doc blocks directly from @storybook/addon-docs/blocks instead of @storybook/addon-docs.

  • Removed block re-exports from code/addons/docs/src/index.ts, keeping only essential exports (DocsRenderer, DocsTypes)
  • Updated import paths across multiple MDX files to use @storybook/addon-docs/blocks directly
  • Added migration guide entry to help users update their import paths
  • Fixed performance issues with fast build feature caused by block imports from main entrypoint
  • Maintains backward compatibility through explicit block path imports

@nx-cloud
Copy link

nx-cloud bot commented Jun 10, 2025

View your CI Pipeline Execution ↗ for commit ecfdd19.

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

☁️ Nx Cloud last updated this comment at 2025-06-10 10:29:49 UTC

@ndelangen ndelangen changed the title Remove export of blocks from main addon-docs entrypoint AddonDocs: Remove export of blocks Jun 10, 2025
@ndelangen ndelangen added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jun 10, 2025
… Storybook. Changed examples from `mdx` to `jsx` format and clarified the new import path for `Meta` from `@storybook/addon-docs/blocks`.
@ndelangen ndelangen marked this pull request as ready for review June 10, 2025 10:40
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

18 files reviewed, no comments
Edit PR Review Bot Settings | Greptile

@ndelangen ndelangen merged commit 58cb556 into next Jun 10, 2025
58 checks passed
@ndelangen ndelangen deleted the norbert/not-expose-blocks-exports-from-docs branch June 10, 2025 10:47
JReinhold pushed a commit that referenced this pull request Jun 10, 2025
…exports-from-docs

AddonDocs: Remove export of blocks
(cherry picked from commit 58cb556)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jun 10, 2025
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

18 files reviewed, no comments
Edit PR Review Bot Settings | Greptile

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