[CL-801] Fix chromatic.yml externals formatting #15736
Merged
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.
🎟️ Tracking
CL-801
📔 Objective
We noticed that a component library PR did not trigger the expected Chromatic UI Test diffs. The PR modified a file that is included in our chromatic workflow’s
externals
configuration, which tells Chromatic to rerun snapshots when anything in “externals” is changed because these files are processed outside of Webpack, where Chromatic sources its dependency graph from. (Docs here) The formatting for our externals didn't match what’s in the docs, so I am updating it to match.📸 Screenshots
This first screenshot is from the PR that had the issue. It is the workflow run from the original commit that changed the file specified in
externals
. Notice that it sees the file changed, but does not run any story files. Turbosnap is enabled, which means all unaffected stories are skipped. Since it doesn't think anything relevant has changed, it skips them all.The following screenshot is from the current PR, from a commit (9f5ddd7) where I made a change to that same file to test the workflow's changes. Notice that it sees the changed file and then disables Turbosnap due to finding a match in the
externals
config. This is the expected behavior! If you check that commit's checks in this PR, you'll see a lot of UI Tests that are now picking up diffs.⏰ Reminders before review
🦮 Reviewer guidelines
:+1:
) or similar for great changes:memo:
) or ℹ️ (:information_source:
) for notes or general info:question:
) for questions:thinking:
) or 💭 (:thought_balloon:
) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion:art:
) for suggestions / improvements:x:
) or:warning:
) for more significant problems or concerns needing attention:seedling:
) or ♻️ (:recycle:
) for future improvements or indications of technical debt:pick:
) for minor or nitpick changes