PORTALS-2652 - Integrate with Chromatic #241
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nickgros
commented
May 17, 2023
| @@ -228,7 +229,8 @@ | |||
| "build:esbuild": "rimraf dist/umd && node esbuild.config.mjs", | |||
| "serve:docs": "pnpm storybook", | |||
| "build:docs": "pnpm build:storybook", | |||
| "build:storybook": "storybook build && touch storybook-static/.nojekyll", | |||
| "build:build:gh-pages": "pnpm build-storybook && touch storybook-static/.nojekyll", | |||
| "build-storybook": "storybook build", | |||
There was a problem hiding this comment.
Chromatic expects a build-storybook command. They let us override with a custom command, but that was causing issues for me where the job would fail without a meaningful error message.
nickgros
commented
May 17, 2023
There was a problem hiding this comment.
No longer build Storybook for each PR since that happens in the new deploy to chromatic job
nickgros
commented
May 17, 2023
Comment on lines
+6
to
+12
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| pull_request_target: | ||
| branches: | ||
| - main |
There was a problem hiding this comment.
Deploy to Chromatic when we push to main (so we always have a deployment target for screenshot diffs) and on pull requests.
Use pull_request_target so we can use the deploy secret. Because we use pull_request_target, this job won't run until this is committed to main (so you won't see the new Chromatic checks on this PR).
jay-hodgson
approved these changes
May 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For an example, see nickgros#3 . There will be two new checks:
The Storybook Publish check links to a deployed Storybook. A PR submitter could link to a specific story in the Storybook if desired, like this.
The UI Tests check links to a list of all of the components where the base snapshot changed since the last deployment. Here's the list of changes from the example PR above. Snapshot diffs can be reviewed and approved. Here's a specific example of a snapshot diff for a component that changed in the example PR. I don't think we'll want to require UI approval to merge for now, but this could be a useful resource to validate a subset of changes.
The number of snapshots we can create per month is limited by the plan that we're on, so we shouldn't rely on this as a part of our SDLC until we understand the value, get a sense of our usage, and can determine if the cost is worth it (or if we should consider alternatives).