@percy/report

1.0.4 • Public • Published

Percy Report Generator

Installation

npm install @percy/report

Export Percy Token

Get percy Read Only or Full Access token from your percy project settings & export it
export PERCY_TOKEN=<read-only | full-access>

Usage

Generate Report - Per Build

npx percy-report generate <buildId> [options]

Note: Build ID can be found in the URL of the Percy Dashboard as well as the REST API data. Example Build URL: https://percy.io/<projectId>/PercyReporting/builds/<buildId>

Options for percy-report generate :

  --percy-token <percyToken>      Percy ReadOnly or FullAccess Token (default: PERCY_TOKEN Environment Variable)
  --download-path <downloadPath>  Directory path where to generate the report (default: "./Reports")
  --download-images               If True Images will be downloaded (default: false)
  --diff-threshold                Threshold for percentage change in snapshots (default : 1)
  -h, --help                      display help for command

Generate Report along with Percy Runs

Step 1 : Run the Percy Build
Step 2 : Extract the Percy Build ID from the Percy run
Step 3 : Execute the Percy Report Generation Step

Example:

export PERCY_TOKEN=<your-percy-token>
BUILD_ID=$(npx percy exec -- {Test Command} | grep build | awk -F "/" '{print $NF}')
npx percy-report generate $BUILD_ID

Generate Project Summary

npx percy-report summary <project-slug> [options]

Note: Project Slug is equal to Project Name on your percy dashboard

Options for summary functionlity

  --percy-token <percyToken>  Percy ReadOnly or FullAccess Token
  --start-date <start-date>   Consider builds created on greater than equal to start date(mm/dd/yyyy) (Default: Today)
  --end-date <end-date>       Consider builds created on less than equal to end date(mm/dd/yyyy) (Default: Today)
  -h, --help                  display help for command

Note: Interval between start date and end date should not exceed 30 days.

Examples

Web Percy

Build Report

percy_web_build_report

Summary Report

percy_web_summary_report

App Percy

Build Report

percy_app_build_report

Summary Report

percy_app_summary_report

Package Sidebar

Install

npm i @percy/report

Weekly Downloads

283

Version

1.0.4

License

MIT

Unpacked Size

1.1 MB

Total Files

16

Last publish

Collaborators

  • percy-admin