-
Notifications
You must be signed in to change notification settings - Fork 24
Add Argos to report visual differences #341
Conversation
✅ Deploy Preview for mellifluous-eclair-326dcd ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
3280e11
to
532465d
Compare
@arturowczarek This sounds cool. Could you provide some example output of using Argos within the project? Perhaps some dummy change on the branch created on the top of this branch to see how does it work within this project. |
@pawel-big-lebowski See arturowczarek#3 and ArgosCI bot comment. There you can click on Review to see that one of the pages has changed (this one) |
When just modifying a markdown, adding a single line causes whole content to go line down and screenshot diff presents entire page red. This tool is cool to verify docs engine configuration changes, but may be an overkill when just editing a content. My understanding is: there are 5000 free screenshots monthly and each run is about 200 screenshots. This means after 25 commits, project runs out of credits and CI will start failing. This doesn't sound that cool, but perhaps I am missing something. |
205c8a8
to
1d446d5
Compare
…ges. Signed-off-by: Artur Owczarek <[email protected]>
@pawel-big-lebowski Please read the updated pull request description. I've added some extra information. The second part of the change is here #352 |
This pull request introduces the first step of visual differences reporting as described in https://docusaurus.io/blog/upgrading-frontend-dependencies-with-confidence-using-visual-regression-testing. I've noticed the used Dinosaurus is obsolete and wanted to update it.
For this pull request to work, we need to sign up to https://app.argos-ci.com/signup and connect it to the repository as described in https://argos-ci.com/docs/github.
This is the first part of the two part change. After merging them both, we'll be able to see the differences like arturowczarek#12 after adding
visual-comparison-required
label.Agros has a free tier of 5000 screenshots per month. One pull request uses around 200 screenshots. There is also an open source tier OpenLineage is eligible for. We have a consent from the Argos creator to have it if we need it.
About changes:
argos
which is configured as a node workspace in rootpackage.json
. It means the run commands from this directory can be executed withworkspace argos
prefix. See.github/workflows/argos.yml
file with yarn commands. For exampleyarn workspace argos screenshot
runs thescreenshot
script fromargos/package.json
file..gitignore
to ignore the temporary things playwright andargos/package.json
were creatingargos/playwright.config.ts
is is the default file located by playwright to take screenshots. It goes back to the root directory, serves the documentation and configures chrome to take screenshotsargos/screenshot.css
contains some css styles as suggested in the original article. It is meant to hide some changes which could make the comparison harder. For example the dynamically generated textpublished 1 minute ago
would change topublished 1 day ago
when we run it the next dayargos/screenshot.spec.ts
- in this file we start taking the screenshots. It is modelled as a test for ease of execution. This script takes all the links fromsitemap.xml
and takes a screenshot