This example will show you how to integrate Diffy.website's visual regression operation into your deployment workflow.

This will allow you to do a comparative visual diff between the live environment and the test environemnt everytime you deploy to the testing environment.

For more advanced use cases, including doing visual regression against Multidev instances, this script can be easily adapted for Diffy.website's REST API: https://diffy.website/rest.

Vide demo is available https://youtu.be/U8uHJELeTDE.

In order to get up and running, you first need to setup a Diffy.website project:

1. Either login to your account or register for a new one at https://diffy.website.
2. Setup a Diffy project for your site and define the Production and Staging URLs in the project settings.

Then you need to add the relevant code to your Pantheon project:

1. Add the example diffyVisualregression.php script to the 'private/scripts/' directory of your code repository.

2. Create an API token in Diffy (). Copy the token and project_id into a file called secrets.json and store it in the private files directory.

     $> echo '{"token": "yourToken", "project_id" : "123"}' > secrets.json
     sftp YOURCREDENTIALS_TO_LIVE_ENVIRONMENT
     sftp> cd files
     sftp> mkdir private
     sftp> cd private
     sftp> put secrets.json
     sftp> quit
     ```
   

3. Add a Quicksilver operation to your pantheon.yml to fire the script after a deploy to test.

api_version: 1

workflows:
  deploy:
    after:
      - type: webphp
        description: Do a visual regression test with Diffy.website
        script: private/scripts/diffyVisualregression.php

4. Make a deploy to test environment!

Optionally, you may want to use the terminus workflows watch YOUR_SITE_ID command to get immediate debugging feedback. First you would need to install and authenticate your terminus.