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

React: Update react-docgen-typescript to fix CI hanging issues #30422

Open
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Jan 30, 2025

Closes #29828

What I did

This PR updates react-docgen-typescript so that it fixes the ongoing issues. It also adds documentation for users who would like to opt-in to the new behavior, which is now under an experimental flag.

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 pull request has been released as version 0.0.0-pr-30422-sha-3b8c2a95. Try it out in a new sandbox by running npx [email protected] sandbox or in an existing project with npx [email protected] upgrade.

More information
Published version 0.0.0-pr-30422-sha-3b8c2a95
Triggered by @valentinpalkovic
Repository storybookjs/storybook
Branch yann/update-react-docgen-typescript
Commit 3b8c2a95
Datetime Thu Jan 30 10:54:14 UTC 2025 (1738234454)
Workflow run 13050807576

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=30422

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 77.9 MB 77.9 MB 119 B 0.95 0%
initSize 131 MB 134 MB 3.41 MB 134.44 2.5%
diffSize 53 MB 56.4 MB 3.4 MB 248.37 🔺6%
buildSize 7.17 MB 7.17 MB 0 B -0.79 0%
buildSbAddonsSize 1.85 MB 1.85 MB 0 B 1.4 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 1.86 MB 1.86 MB 0 B -0.82 0%
buildSbPreviewSize 0 B 0 B 0 B - -
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 3.91 MB 3.91 MB 0 B -0.74 0%
buildPreviewSize 3.26 MB 3.26 MB 0 B -0.81 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 15.2s 21.2s 6s 0.57 28.4%
generateTime 17.9s 19.3s 1.3s -0.65 7.2%
initTime 11.3s 13s 1.6s -0.51 12.7%
buildTime 8.4s 8.2s -206ms -1.07 -2.5%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 4.9s 4.8s -28ms -0.35 -0.6%
devManagerResponsive 3.6s 3.6s 15ms -0.26 0.4%
devManagerHeaderVisible 699ms 756ms 57ms 0.53 7.5%
devManagerIndexVisible 709ms 768ms 59ms 0.29 7.7%
devStoryVisibleUncached 3.9s 4s 120ms 1.54 3%
devStoryVisible 730ms 837ms 107ms 0.74 12.8%
devAutodocsVisible 644ms 797ms 153ms 1.14 19.2%
devMDXVisible 619ms 805ms 186ms 1.43 🔺23.1%
buildManagerHeaderVisible 677ms 793ms 116ms 0.28 14.6%
buildManagerIndexVisible 768ms 932ms 164ms 0.4 17.6%
buildStoryVisible 666ms 782ms 116ms 0.31 14.8%
buildAutodocsVisible 683ms 584ms -99ms -0.19 -17%
buildMDXVisible 534ms 764ms 230ms 1.45 🔺30.1%

Greptile Summary

Based on the provided information, I'll create a concise summary of the pull request changes:

Updates the @joshwooding/vite-plugin-react-docgen-typescript dependency to version 0.5.0 to resolve CI hanging issues in Storybook's React frameworks.

  • Updated dependency in code/frameworks/react-native-web-vite/package.json to fix CI build hangs
  • Updated dependency in code/frameworks/react-vite/package.json for consistent version across frameworks
  • Added documentation in docs/api/main-config/main-config-typescript.mdx for Vite-specific configuration
  • Added migration notes in MIGRATION.md for new experimental performance flag and development mode feature

@yannbf yannbf added bug ci:merged Run the CI jobs that normally run when merged. docgen labels Jan 30, 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

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

Copy link

nx-cloud bot commented Jan 30, 2025

View your CI Pipeline Execution ↗ for commit 8737633.

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

☁️ Nx Cloud last updated this comment at 2025-01-30 14:13:11 UTC

@yannbf yannbf added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jan 30, 2025
@storybook-pr-benchmarking
Copy link

storybook-pr-benchmarking bot commented Jan 30, 2025

Package Benchmarks

Commit: 8737633, ran on 30 January 2025 at 14:16:57 UTC

The following packages have significant changes to their size or dependencies:

@storybook/addon-storysource

Before After Difference
Dependency count 7 7 0
Self size 1.89 MB 1.89 MB 0 B
Dependency size 10.74 MB 10.80 MB 🚨 +63 KB 🚨
Bundle Size Analyzer Link Link

@storybook/experimental-nextjs-vite

Before After Difference
Dependency count 153 188 🚨 +35 🚨
Self size 232 KB 232 KB 0 B
Dependency size 44.74 MB 48.24 MB 🚨 +3.49 MB 🚨
Bundle Size Analyzer Link Link

@storybook/react-native-web-vite

Before After Difference
Dependency count 137 176 🚨 +39 🚨
Self size 43 KB 43 KB 0 B
Dependency size 19.90 MB 23.45 MB 🚨 +3.55 MB 🚨
Bundle Size Analyzer Link Link

@storybook/react-vite

Before After Difference
Dependency count 87 128 🚨 +41 🚨
Self size 13 KB 13 KB 0 B
Dependency size 16.07 MB 19.64 MB 🚨 +3.56 MB 🚨
Bundle Size Analyzer Link Link

@storybook/cli

Before After Difference
Dependency count 388 388 0
Self size 503 KB 503 KB 0 B
Dependency size 75.28 MB 75.34 MB 🚨 +63 KB 🚨
Bundle Size Analyzer Link Link

@storybook/codemod

Before After Difference
Dependency count 277 277 0
Self size 612 KB 612 KB 0 B
Dependency size 65.36 MB 65.42 MB 🚨 +63 KB 🚨
Bundle Size Analyzer Link Link

@storybook/source-loader

Before After Difference
Dependency count 5 5 0
Self size 41 KB 41 KB 0 B
Dependency size 10.68 MB 10.75 MB 🚨 +63 KB 🚨
Bundle Size Analyzer Link Link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:merged Run the CI jobs that normally run when merged. docgen patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Storybook hangs/doesn't finish building 8.4.6/8.4.7
2 participants