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

Blocks: Prebundle tocbot #28318

Merged
merged 2 commits into from
Jul 5, 2024
Merged

Blocks: Prebundle tocbot #28318

merged 2 commits into from
Jul 5, 2024

Conversation

shilman
Copy link
Member

@shilman shilman commented Jun 23, 2024

Closes #28307

What I did

When we prebundle libraries it resolves ESM/CJS issues like #28307 because we publish CJS versions of

Did not have a good repro for the problem but verified with the user that the canary fixes the problem in their project. I also tested it in a fresh project on my local machine.

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

  1. Fire up a project with the canary
  2. Enable TOC with parameters: { docs: { toc: {} } } in .storybook/preview.ts
  3. Navigate to an autodocs page and verify that the TOC displays properly

🦋 Canary release

This pull request has been released as version 0.0.0-pr-28318-sha-24019b5c. Try it out in a new sandbox by running npx storybook@0.0.0-pr-28318-sha-24019b5c sandbox or in an existing project with npx storybook@0.0.0-pr-28318-sha-24019b5c upgrade.

More information
Published version 0.0.0-pr-28318-sha-24019b5c
Triggered by @shilman
Repository storybookjs/storybook
Branch shilman/28307-prebundle-tocbot
Commit 24019b5c
Datetime Sun Jun 23 12:50:19 UTC 2024 (1719147019)
Workflow run 9633583213

To request a new release of this pull request, mention the @storybookjs/core team.

core team members can create a new canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=28318

Copy link

nx-cloud bot commented Jun 23, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 86ac7f0. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@shilman shilman added block: other and removed maintenance User-facing maintenance tasks labels Jul 3, 2024
@shilman shilman marked this pull request as ready for review July 3, 2024 15: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.

PR Summary

  • Moved 'tocbot' from dependencies to devDependencies in /code/lib/blocks/package.json
  • Aimed at optimizing build process
  • Likely reduces production bundle size

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

@ndelangen ndelangen changed the title Blocks: Prebundle tocbot Blocks: Prebundle tocbot Jul 5, 2024
@shilman shilman merged commit e6a2947 into next Jul 5, 2024
62 of 63 checks passed
@shilman shilman deleted the shilman/28307-prebundle-tocbot branch July 5, 2024 14:24
@github-actions github-actions bot mentioned this pull request Jul 5, 2024
9 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.

[Bug]: tocbot dependency causing ERR_REQUIRE_ESM error on next dev and next build
2 participants