Skip to content

Tech Story: [M3-7947] - Update storybook to 8.0.5 - #10336

Merged
abailly-akamai merged 3 commits into
linode:developfrom
abailly-akamai:M3-7947
Apr 2, 2024
Merged

abailly-akamai merged 3 commits into
linode:developfrom
abailly-akamai:M3-7947

Conversation

@abailly-akamai

@abailly-akamai abailly-akamai commented Apr 1, 2024 •

Copy link
Copy Markdown
Contributor

Description 📝

PR to update storybook to 8.0.5

I did not change anything to how we're type-checking or compiling. This could be done in subsequent optimizing PRs. It should be a 1/1 update to prepare us to adopt some extra features down the line.

I took a brief stab at adopting react-docgen (much faster, instead of react-docgen-typescript) by default since it is much faster, but type fidelity benefits were lost so best to keep the current config for now.

Changes 🔄

  • Update CM storybook to 8.0.5
  • Update other relevant packages
  • Update relevant imports
  • Update last remaining .mdx file

Preview 📷

There should be no degradation or regression to our storybook as a result of this PR

How to test 🧪

Verification steps

  • Pull PR locally
  • Run yarn storybook and browse stories to confirm no regressions
  • Run yarn build-storybook and storybook-static to confirm build will succeeds in our pipelines

As an Author I have considered 🤔

Check all that apply

  • 👀 Doing a self review
  • ❔ Our contribution guidelines
  • 🤏 Splitting feature into small PRs
  • ➕ Adding a changeset
  • 🧪 Providing/Improving test coverage
  • 🔐 Removing all sensitive information from the code and PR description
  • 🚩 Using a feature flag to protect the release
  • 👣 Providing comprehensive reproduction steps
  • 📑 Providing or updating our documentation
  • 🕛 Scheduling a pair reviewing session
  • 📱 Providing mobile support
  • ♿ Providing accessibility support

@abailly-akamai abailly-akamai self-assigned this Apr 1, 2024
@abailly-akamai
abailly-akamai marked this pull request as ready for review April 1, 2024 17:50
@abailly-akamai
abailly-akamai requested a review from a team as a code owner April 1, 2024 17:50
@abailly-akamai
abailly-akamai requested review from jdamore-linode and mjac0bs and removed request for a team April 1, 2024 17:50
@abailly-akamai abailly-akamai changed the title change: [M3-7947] - Update storybook to 8.0.5 Tech Story: [M3-7947] - Update storybook to 8.0.5 Apr 1, 2024
@github-actions

github-actions Bot commented Apr 1, 2024 •

Copy link
Copy Markdown

Coverage Report: ✅
Base Coverage: 81.75%
Current Coverage: 81.75%

@bnussman-akamai bnussman-akamai left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Awesome. Thank you 🎉

  • Confirmed local dev works
  • Confirmed build works
  • Confirmed react-docgen-typescript generates better docs than react-docgen
  • Confirmed stories show and render as expected
  • Confirmed dark mode toggle works as expected

@mjac0bs mjac0bs left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you! 📖 🚀 Build steps ran successfully, Storybook started successfully locally and from browsing various pages and adjusting props in the playgrounds, I did not see any regressions.

Screenshot 2024-04-01 at 2 24 15 PM
Screenshot 2024-04-01 at 2 24 57 PM

Comment thread packages/manager/src/components/intro.mdx Outdated
Comment thread packages/manager/.changeset/pr-10336-tech-stories-1711993874664.md Outdated
@mjac0bs mjac0bs added Approved Multiple approvals and ready to merge! Storybook labels Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved Multiple approvals and ready to merge! Storybook

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants