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

feat(storybook)!: update chromatic add-on to latest version #3458

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

castastrophe
Copy link
Collaborator

@castastrophe castastrophe commented Dec 22, 2024

Description

Chromatic moved away from @chromaui/addon-visual-tests to the @chromatic-com/storybook package.

This requires an update to the chromatic.config.json settings, removal of the generic argTypesRegex from the preview config, and a stricter import in the doc blocks (i.e., fileName.js not just fileName).

To support a successful build, our test command must maintain the autodocs and mdx syntax which requires we add this information to our build instructions in the .storybook/main.js file.

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

Expect to be able to run Storybook locally, connect to the Chromatic add-on in the component panel, and kick off a manual re-run of VRTs.

Screenshots

To-do list

  • I have read the contribution guidelines.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

Copy link

changeset-bot bot commented Dec 22, 2024

🦋 Changeset detected

Latest commit: d0cda87

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@spectrum-css/preview Major

Not sure what this means? Click here to learn what changesets are.

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

Copy link
Contributor

github-actions bot commented Dec 22, 2024

🚀 Deployed on https://pr-3458--spectrum-css.netlify.app

Copy link
Contributor

github-actions bot commented Dec 22, 2024

File metrics

Summary

Total size: 4.27 MB*

🎉 No changes detected in any packages

* Size determined by adding together the size of the main file for all packages in the library.
* Results are not gzipped or minified.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

@castastrophe castastrophe force-pushed the feat-upgrade-chromatic-storybook-addon branch 3 times, most recently from bc40fa2 to 0d1bab2 Compare January 2, 2025 16:42
@castastrophe castastrophe self-assigned this Jan 2, 2025
@castastrophe castastrophe force-pushed the feat-upgrade-chromatic-storybook-addon branch from 0d1bab2 to 2ffe037 Compare January 2, 2025 16:49
@castastrophe castastrophe marked this pull request as ready for review January 2, 2025 16:50
@@ -1,5 +1,3 @@
{/* DocumentationTemplate.mdx */}
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The build "test" command does not like these comments! Easier to just remove them than try to rework them.

@castastrophe castastrophe changed the title feat(storybook): update chromatic add-on to latest version feat(storybook)!: update chromatic add-on to latest version Jan 2, 2025
@castastrophe castastrophe added dependencies Pull requests that update a dependency file storybook ready-for-review labels Jan 2, 2025
@castastrophe castastrophe force-pushed the feat-upgrade-chromatic-storybook-addon branch from 2ffe037 to 7a869a3 Compare January 2, 2025 23:58
@@ -0,0 +1,12 @@
---
"@spectrum-css/preview": major
Copy link
Collaborator

Choose a reason for hiding this comment

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

@castastrophe- with the config updates, additions to the env file, the dependency technically changed, I think major seems appropriate.

@castastrophe castastrophe force-pushed the feat-upgrade-chromatic-storybook-addon branch 2 times, most recently from 9f398fd to 716a13a Compare January 6, 2025 18:13
BREAKING CHANGE: New chromatic configuration required for updated
version support.
@castastrophe castastrophe force-pushed the feat-upgrade-chromatic-storybook-addon branch from 716a13a to d0cda87 Compare January 6, 2025 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file ready-for-review storybook
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants