Visual tests

What it does

This action runs visual regression tests with Visual Tests 2.0 and reports differences between current page screenshots and an approved baseline.

How it works

The action collects pages from configured URLs, a sitemap, or a file and runs them against a Visual Tests suite. You can control page discovery, exclude selected URLs or elements, provide request headers and cookies, and wait for dynamic content before screenshots are captured.

Visual Tests Action Features

• Test explicit URLs or discover pages from a sitemap, linked pages, or a URL file
• Exclude URLs with regular expressions and ignore page elements with CSS or XPath selectors
• Respect robots.txt when discovering pages
• Set scoped cookies and HTTP headers for authenticated or customized requests
• Add delays and wait for elements before taking screenshots
• Run tests against target servers or clusters
• Configure the action in YAML mode using the Visual Tests YAML parameters
• Manage the action with the Visual Tests API
• Run the action conditionally based on repository changes or environment variable values