Hey! These docs are for version 1, which is no longer officially supported. Click here for the latest version, 2!

Configuration

Global build configuration with Percy Agent

Percy Agent is primarily configured by creating a .percy.yml file. This yaml file allows you to globally set configuration for each build. The .percy.yml configuration file must exist in the directory where you run the percy from.

We currently support for the following configuration options:

  • snapshot
    • widths: an array of numbers, in pixels, representing the widths you'd like to capture for each snapshot. Default: [375, 1280]
    • min-height: a number specifying the minimum height in pixels each snapshot should be. Default: 1024

Example of setting all configuration options:

version: 1
snapshot:
  widths: [375, 1280]
  min-height: 1024

A common use case is configuring all snapshots in a build to capture the same widths. You can do so with the following:

version: 1
snapshot:
  widths: [375, 1280, 2048]