Skip to content

[CL-801] Fix chromatic.yml externals formatting #15736

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

Merged
merged 4 commits into from
Jul 23, 2025
Merged

Conversation

vleague2
Copy link
Contributor

@vleague2 vleague2 commented Jul 22, 2025

🎟️ 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.

Screenshot 2025-07-22 at 3 54 48 PM

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.

Screenshot 2025-07-22 at 3 55 57 PM

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team

🦮 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

Copy link
Contributor

github-actions bot commented Jul 22, 2025

Logo
Checkmarx One – Scan Summary & Detailsf3435591-97b7-4660-ba95-b8da3d04e886

Great job, no security vulnerabilities found in this Pull Request

Copy link

codecov bot commented Jul 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.58%. Comparing base (319528c) to head (2f7f38a).
Report is 16 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #15736   +/-   ##
=======================================
  Coverage   37.58%   37.58%           
=======================================
  Files        3320     3320           
  Lines       94806    94806           
  Branches    14343    14343           
=======================================
  Hits        35629    35629           
  Misses      57681    57681           
  Partials     1496     1496           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link

@vleague2 vleague2 marked this pull request as ready for review July 22, 2025 20:09
@vleague2 vleague2 requested a review from a team as a code owner July 22, 2025 20:09
@vleague2 vleague2 requested a review from addisonbeck July 22, 2025 20:09
@vleague2 vleague2 changed the title try changing format of externals list [CL-801] Fix chromatic.yml externals formatting Jul 22, 2025
@vleague2 vleague2 merged commit d45cacc into main Jul 23, 2025
31 checks passed
@vleague2 vleague2 deleted the uif/chromatic-externals branch July 23, 2025 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants