Skip to content
On this page

Percy Analysis

Percy is an all-in-one visual testing and review platform. This extension will include the number of snapshots approved and needs to be reviewed.

DEFAULTS
  • hook: end
  • condition: passOrFail

Syntax

json
{
  "name": "percy-analysis",
  "inputs": {
    "token": "<api-token>",
    "project_name": "<project-name>"
  }
}
  • token (string) - percy integration token with read or full access.
  • project_name? (string) - name of the project for reporting the last finished build results.

    Mandatory, if project_id and build_id are not available

  • project_id? (string) - id of the project for reporting the last finished build results.

    Mandatory, if project_name and build_id are not available

  • build_id? (string) - id of the build for reporting.

    Mandatory, if project_name and project_id are not available

  • retries? (string) - no. of retries to perform for a build to finish.

    Defaults to 10. It waits 5 seconds between each try.

Reports

Teams

teams-link

Examples

Using project_name

json
{
  "targets": [
    {
      "name": "teams",
      "inputs": {
        "url": "<teams-incoming-webhook-url>"
      },
      "extensions": [
        {
          "name": "percy-analysis",
          "inputs": {
            "token": "<api-token>",
            "project_name": "<project-name>"
          }   
        }
      ]
    }
  ],
  "results": [
    {
      "type": "testng",
      "files": ["path/to/testng-results.xml"]
    }
  ]
}

Released under the MIT License.