Skip to content

BrowserStackCE/percy-build-diff-summary

Repository files navigation

Percy Build Report Generator

This tool fetches snapshots from a specific Percy build via the BrowserStack/Percy API, calculates visual and AI diff percentages, and provides a downloadable CSV report.


🚀 Getting Started

  1. Clone the repository and install dependencies:
    npm install
  2. Get your Token:
    • Log into Percy.io.
    • Go to Project Settings.
    • Copy the Read-only Token.
  3. Run the App:
    npm run dev

🛠 How to Use

  1. Enter Token: Paste your Percy Read-only token into the first input field.
  2. Enter Build URL: Paste the full URL of the build you want to analyze (e.g., https://percy.io/org/project/builds/1234567).
  3. Generate Report: Click "Get Report". The app will:
    • Identify the project slug and organization.
    • Fetch all snapshots (handling pagination automatically).
    • Calculate diff ratios as percentages.
  4. Export: Use the "Download CSV" button to save the results for stakeholder reporting.

📊 Data Points Captured

Column Description
Snapshot Name The name defined in your test suite.
Visual Diff % The percentage of pixels changed across all viewports.
Percy URL A direct deep-link to the /changed/ view for that snapshot.

📁 Tech Stack

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages