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

chore(docs): upgrade to Storybook 6 #660

Merged
merged 6 commits into from
Aug 17, 2020
Merged

chore(docs): upgrade to Storybook 6 #660

merged 6 commits into from
Aug 17, 2020

Conversation

connor-baer
Copy link
Member

@connor-baer connor-baer commented Aug 15, 2020

Closes #578.

Purpose

From #578:

The next major version of Storybook, our development environment & documentation tool, was released this week. Most notably, it greatly improves support for TypeScript and adds Storybook Args, a new API for interactive component examples.

We've started to gradually migrate Circuit UI to TypeScript (#516). All changes and new components should be done in TypeScript. Upgrading Storybook now would make our lives a lot easier while enabling powerful new features.

Among other things, this fixes the props table for TypeScript components.

Approach and changes

  • upgrade all Storybook dependencies to v6
  • fix incompatibilities, remove deprecated code, and apply migration steps as outlined in the migration guide
  • rename *.story.* files to *.stories.*

Definition of done

  • Development completed
  • Reviewers assigned
  • Unit and integration tests
  • Meets minimum browser support
  • Meets accessibility requirements

@connor-baer connor-baer added 🛠️ tech Changes to the tech stack or infrastructure 📋 documentation Adds or improves documentation labels Aug 15, 2020
@connor-baer connor-baer added this to the v2.x milestone Aug 15, 2020
@vercel
Copy link

vercel bot commented Aug 15, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/sumup-oss/circuit-ui/huuy68ll0
✅ Preview: https://circuit-ui-git-tech-storybook-6.sumup-oss.vercel.app

@codecov
Copy link

codecov bot commented Aug 15, 2020

Codecov Report

Merging #660 into canary will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           canary     #660   +/-   ##
=======================================
  Coverage   93.52%   93.52%           
=======================================
  Files         131      131           
  Lines        2241     2241           
  Branches      651      651           
=======================================
  Hits         2096     2096           
  Misses        119      119           
  Partials       26       26           
Impacted Files Coverage Δ
src/components/Carousel/components/Slide/Slide.js 100.00% <100.00%> (ø)
...components/Table/components/TableCell/TableCell.js 100.00% <100.00%> (ø)

Storybook applies some optimizations to story files and assumes a default name of `*.stories.*`.
@connor-baer connor-baer merged commit 6b2b511 into canary Aug 17, 2020
@connor-baer connor-baer deleted the tech/storybook-6 branch August 17, 2020 11:35
@github-actions
Copy link
Contributor

🎉 This PR is included in version 2.1.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions
Copy link
Contributor

🎉 This PR is included in version 2.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📋 documentation Adds or improves documentation 🛠️ tech Changes to the tech stack or infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Upgrade to Storybook 6
2 participants