Jump to Content
Percy Documentation
DocsAPI Reference
Sign in or start for freePercy Documentation
Docs
Sign in or start for free
GitHub Enterprise Server

Overview

  • Getting started
    • All integrations
  • Your first Percy build
  • Visual testing basics
  • Percy basics
  • Plans and billing
  • Tutorials
    • Ember tutorial
    • Capybara tutorial
    • Storybook tutorial
    • Cypress tutorial
    • Puppeteer tutorial
    • Selenium for Java tutorial
    • Selenium for .NET tutorial
    • Selenium for JavaScript tutorial
    • Selenium for Python tutorial
    • Selenium for Ruby tutorial
    • Nightmare tutorial
    • Nightwatch tutorial
    • Protractor tutorial
    • WebDriverIO tutorial
    • TestCafe tutorial
    • Playwright tutorial
    • Percy on Automate Integration Tutorial (Selenium)

Percy With Browserstack sdk

  • Integrate Percy using BrowserStack SDK

CLI

  • Commands overview
    • Percy exec
    • Percy snapshot
    • Percy upload
    • Percy config
    • Percy build
  • Configuration
    • Skipping the asset discovery browser download
    • Capturing responsive DOM snapshots
    • Capturing multiple asset hosts
    • Capturing assets protected with authentication
    • Caching the asset discovery browser in CI
    • Modify serialised DOM using domTransformation
  • Migrating to Percy CLI

SDKs

  • SDKs overview
  • Percy Snapshot
  • Web applications
    • Ember
    • Rails
    • Capybara
  • Components
    • Storybook
    • Cypress
  • End-to-end testing
    • Cypress
    • Puppeteer
    • Playwright
    • Selenium for Java
    • Selenium for .NET
    • Selenium for JavaScript
    • Selenium for Python
    • Selenium for Ruby
    • WebdriverIO
    • Nightmare
    • Nightwatch
    • Protractor
    • TestCafe
    • Appium mobile browser testing
  • Static sites
    • Snapshot CLI command
    • Gatsby
    • Jekyll
  • Debugging SDKs
    • Capturing lazy loading images
  • Build your own SDK

Setup

  • Running locally
  • Continuous Integration (CI) setup
    • AppVeyor
    • Azure Pipelines
    • Bitbucket Pipelines
    • Buildkite
    • CircleCI
    • CodeShip
    • Drone
    • GitHub Actions
    • GitLab CI
    • Harness CI
    • Jenkins
    • Netlify
    • Semaphore
    • Travis CI
    • Other
  • Environment variables
  • Parallel test suites
  • Integrate functional and visual tests

Workflow

  • Source code integrations
    • GitLab
    • GitHub
    • GitHub Enterprise Server
    • GitLab Self-Managed
    • Bitbucket Cloud
    • Bitbucket Server
    • Enterprise firewalls
    • Azure DevOps
  • Multiple projects per repo
  • Base build selection
  • Base snapshots selection
  • Base snapshot selection strategy - Git vs Visual Git
  • Comments and notifications
  • Approval workflow
  • Changes requested workflow
  • Slack integration
  • Bring Your Visual Reviews to Microsoft Teams
  • Webhooks
    • Webhook Payloads
  • Base build selection tutorial

Features

  • Percy specific CSS
  • Responsive visual testing
  • Cross-browser visual testing
    • Browsers specific handling
  • Automatic diff matching
  • Public projects
    • Percy badge
  • Branch filtering via regex
  • Diff sensitivity
  • Screenshot a single element
  • Visual testing on mobile browsers
    • Text stability in iOS
  • Diff highlighter
  • Ignore regions
  • Shadow DOM
  • Enterprise Features

Recipes

  • Workflows
    • Partial builds
    • Comparing two URLs to each other
    • Upgrading your project's browsers
    • Accepting invites to a classic Percy organization

Screenshot stabilization

  • Handling redirections
  • Freezing animations
  • Handling dynamic data
  • Third-party fonts
  • Ignoring 1px diffs
  • Video handling
    • Mobile Browsers Behavior
  • Lazy loading
  • Browsers specific behaviour
  • Sticky element

Troubleshoot/FAQs

  • Troubleshoot Issues