Skip to content

Conversation

joshfarrant
Copy link
Contributor

@joshfarrant joshfarrant commented Jul 26, 2024

Summary

Update Storybook to latest, along with associated dependencies. Also moves preview deploys to live under /brand to match production.

List of notable changes:

  • Packages
    • Updated Storybook (and its addons) from 7.6.17 to 8.2.6 (latest).
    • Updated TypeScript from 4.9.5 to 5.5.4 (latest).
    • Updated jest and ts-jest from 27.5.1 to 29.7.0 (latest).
    • Added jest-environment-jsdom as that's no longer included in jest and must be installed separately.
  • Deploy preview builds under /brand to more closely match production and make asset handling simpler in preview deploys.
  • Modified paths of static assets in docs and storybook to point to their respective local static directories
  • Updated axe-clean.spec.ts to use new index.json format instead of deprecated stories.json
  • Updated playwright.generate-tests.ts to use new index.json format instead of deprecated stories.json
    • This has caused the visual specs to be sorted in a slightly different order. This shouldn't have any actual effect, but that's the reason for the changes to the *.visual.spec.ts files. Because of this, it might be easier to view those changes in isolation when reviewing this PR

What should reviewers focus on?

  • Verify that the docs and storybook work as expected on the preview deploy now that they're being served under /brand
  • Check that all our tests pass and the package updates haven't introduced any regressions

Steps to test:

Supporting resources (related issues, external links, etc):

Contributor checklist:

  • All new and existing CI checks pass
  • Tests prove that the feature works and covers both happy and unhappy paths
  • Any drop in coverage, breaking changes or regressions have been documented above
  • New visual snapshots have been generated / updated for any UI changes
  • All developer debugging and non-functional logging has been removed
  • Related issues have been referenced in the PR description

Reviewer checklist:

  • Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
  • Check that tests prove the feature works and covers both happy and unhappy paths
  • Check that there aren't other open Pull Requests for the same update/change

Copy link

changeset-bot bot commented Jul 26, 2024

⚠️ No Changeset found

Latest commit: b2af2ad

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Jul 26, 2024

🟢 No design token changes found

Copy link
Contributor

github-actions bot commented Jul 26, 2024

🟢 No visual differences found

Our visual comparison tests did not find any differences in the UI.

@joshfarrant joshfarrant force-pushed the joshfarrant/storybook-8.2.6 branch from d06e624 to de77feb Compare July 26, 2024 13:55
@joshfarrant joshfarrant force-pushed the joshfarrant/storybook-8.2.6 branch from 2a21243 to 45f6920 Compare July 29, 2024 15:06
@joshfarrant joshfarrant changed the title update storybook to latest and run migrations Update Storybook to 8.2.6 (latest) Jul 30, 2024
@joshfarrant joshfarrant changed the title Update Storybook to 8.2.6 (latest) Update Storybook to 8.2.6 (latest), and move preview deploys to /brand Jul 30, 2024
@joshfarrant joshfarrant force-pushed the joshfarrant/storybook-8.2.6 branch from e1f5cc7 to bda43a9 Compare August 6, 2024 07:24
@joshfarrant joshfarrant requested a review from rezrah August 6, 2024 08:29
Copy link
Collaborator

@rezrah rezrah left a comment

Choose a reason for hiding this comment

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

This is looking great 🙌

@joshfarrant - just two minor questions about dependency changes. Also could you please update the snapshots one more time to be sure there's no additional regressions with the latest changes please, seems like it hasn't run in a while.

@joshfarrant
Copy link
Contributor Author

Thanks @rezrah, I've responded to and resolved both comments

I've been running the snapshot update in docker locally and all's good, but I've re-applied the label again just to be sure 👍

@joshfarrant joshfarrant merged commit 8019e3d into main Aug 6, 2024
19 checks passed
@joshfarrant joshfarrant deleted the joshfarrant/storybook-8.2.6 branch August 6, 2024 09:05
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.

2 participants