-
Notifications
You must be signed in to change notification settings - Fork 34
docs(adr): add Percy automation ADR #515
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
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
be04cf9
docs(adr): add Percy automation ADR
HenriqueLimas afa5411
docs: update name and ADR id
HenriqueLimas 6c9e8c2
Apply suggestions from code review
HenriqueLimas f291a70
docs(adr): refocus Percy ADR on tool selection over automation
HenriqueLimas b440f0d
Update docs/adr/0003-visual-regression-testing-tool.md
HenriqueLimas 942ae9f
Update docs/adr/0003-visual-regression-testing-tool.md
HenriqueLimas 43341d8
Apply suggestion from @HenriqueLimas
HenriqueLimas 6651a0b
docs(adr): restore Percy automation context and tradeoffs
HenriqueLimas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # 3. Visual Regression Testing Tool | ||
|
|
||
| Date: 2026-02-12 | ||
|
|
||
| ## Status | ||
|
|
||
| Accepted | ||
|
|
||
| ## Context | ||
|
|
||
| We need visual regression testing to catch unintended UI changes across our component library. With approximately 990 visual snapshots across our components, we needed to evaluate different visual regression testing tools to determine the best fit for our needs. | ||
|
|
||
| The primary options considered were: | ||
|
|
||
| - **Percy**: A visual testing platform with cross-browser support and cloud infrastructure | ||
| - **visual-html**: An eBay open-source tool for visual regression testing (https://github.com/eBay/visual-html) | ||
| - **Vitest snapshot testing**: Built-in snapshot capabilities in our existing test framework | ||
|
|
||
| ## Decision | ||
|
|
||
| We will use Percy for visual regression testing. | ||
|
|
||
| Key factors in this decision: | ||
|
|
||
| 1. **Existing infrastructure**: We already have an existing Percy account, eliminating procurement and setup overhead | ||
| 2. **Cross-browser testing**: Percy provides testing across multiple browsers (Chrome, Firefox, Safari, Edge), which visual-html does not natively support | ||
| 3. **Accurate**: Percy has been found to be accurate in finding differences between snapshots. Some other tools tend to show a lot of false positive | ||
| 4. **Cloud infrastructure**: Percy's cloud-based service provides a good UI to quickly see the visual differences and approve the build. | ||
|
|
||
| ## Consequences | ||
|
|
||
| **Positive:** | ||
|
|
||
| - Cross-browser visual regression coverage without additional infrastructure | ||
| - Leverages existing eBay Percy enterprise plan | ||
HenriqueLimas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - No need to maintain custom visual regression infrastructure | ||
| - Better collaboration through Percy's PR integration and review UI | ||
|
|
||
| **Negative:** | ||
|
|
||
| - Ongoing costs based on snapshot count (~990 snapshots) | ||
| - Requires careful cost management through partial builds (only running snapshots for changed components) | ||
| - Dependency on external service rather than an internal eBay tool | ||
| - Must trigger full builds when global files change (tokens, variables, mixins) | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a couple of other factors IMO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree with this