-
Notifications
You must be signed in to change notification settings - Fork 364
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
fix: [M3-8904] - Fix Storybook docgen #11264
fix: [M3-8904] - Fix Storybook docgen #11264
Conversation
Coverage Report: ✅ |
Cloud Manager UI test results🎉 445 passing tests on test run #2 ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't even load storybook anymore but that's unrelated to this change. The cache is messed up (we gonna need to configure optimizeDeps
).
Changes look good otherwise.
Have you considered keeping an include
in reactDocgenTypescriptOptions
to only target the packages we care about (manager and UI). Not sure about performance benefits but worth mentioning
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All checks pass ✅
More comprehensive documentation is displayed in Storybook ✅
On the fence considering the marginal gain from added configuration. |
Cloud Manager E2E Run #6831
Run Properties:
|
Project |
Cloud Manager E2E
|
Branch Review |
develop
|
Run status |
Passed #6831
|
Run duration | 27m 46s |
Commit |
8492246e4c: fix: [M3-8904] - Fix Storybook docgen (#11264)
|
Committer | Hussain Khalil |
View all properties for this run ↗︎ |
Test results | |
---|---|
Failures |
0
|
Flaky |
2
|
Pending |
2
|
Skipped |
0
|
Passing |
452
|
View all changes introduced in this branch ↗︎ |
Description 📝
Fixes docgen in Storybook, which is currently broken when launching through
yarn storybook
. Docgen converts TSDoc comments into documentation for props and components.Changes 🔄
main.ts
and the related utilitygetReactDocgenTSFileGlobs
, which was broken by test: [M3-8809] - Add vitest workspace configuration #11184.Preview 📷
How to test 🧪
yarn storybook