Autopilot Setup and Configuration

Enable and configure Autopilot visual regression testing (VRT) for your WordPress or Drupal site.

Discuss in our Forum Discuss in Slack

Enable Autopilot

Autopilot can be enabled for individual sites within each eligible Workspace.

To work with Autopilot, switch to the Workspace for the site's Organization before you continue.

Autopilot Overview page shows sites available for Autopilot

  1. If the site is in SFTP mode with staged changes that haven't been committed yet, commit those changes first.

  2. In the Global Primary Navigation, click the Autopilot icon.

  3. Sites for which Autopilot is available are listed in the All Sites column of the Sites table.

  4. Click Activate in the Site's row.

    During setup, use the buttons at the bottom to navigate between steps. If you use the browser's back button instead of Go Back, you'll lose the unsaved changes.

  5. In the Configuration step, use the On/Off toggles to choose which features and elements should be tracked for, or excluded from, updates then click Continue to set a schedule and deployment destination for Autopilot.

    Any elements that Autopilot detects as available for exclusion will be listed in each category (Modules, Plugins, Themes). Click Manage Excluded Updates then the Exclude button on the element's row to exclude it from Autopilot updates.

    Autopilot Setup - Configuration screen. Select whether Autopilot should track changes to the Upstream, plugins, or themes.

  6. Schedule Autopilot to run:

    Then use the dropdown menu to choose the deployment destination:

    • Dev
    • Test
    • Live

    Autopilot Setup - Schedule screen. Select how frequently Autopilot should run and where successful updates should be applied.

    Click Continue to choose pages for screenshot comparison tests.

  7. Add pages to track for visual regression testing. Autopilot automatically suggests up to ten URL paths during setup:

    Autopilot Setup - Visual Review screen. Select which pages should be covered by visual regression testing.

    Click Save to initialize Autopilot on the Site.

  8. Click Status in the Autopilot sidebar for the current status of the testing. This process might take a while:

    Autopilot Sidebar - The sidebar shows links to Status, Activity, and Configuration screens.

Autopilot Configuration - Manage Autopilot Settings

From the Autopilot page of the Workspace, click Actions , then Manage Autopilot Settings.

The Autopilot Configuration page shows all the steps from the initial setup on one page.

If the Site uses Integrated Composer (including all Drupal 9 sites), Autopilot will show warnings in the sections where Composer manages updates.

Click Save for each section of the configuration in which you make changes.

Update Scope

Use the On/Off toggles to choose which features and elements should be tracked for updates then click Save.

Autopilot Configuration screen - Customize the type of updates included in the automated updates.

Destination & Frequency

Autopilot Configuration screen - Determine how often Autopilot runs on this site, and where successful updates are deployed.

Use the Deployment Destination dropdown menu to choose which environment Autopilot should deploy up to:

  • Dev
  • Test
  • Live

Set the Update Frequency to schedule Autopilot to run:

  • Never (Update Manually)
  • Weekly
  • Monthly

Click Save to save the changes.

Visual Test Screenshots

Add pages to track for visual regression testing, along with a percent of acceptable change.

Autopilot Configuration - Visual Test Screenshots

Click Add to add more pages.

Click Save to save changes.

Acceptable Change

Autopilot allows you to configure a threshold of acceptable change so that small, expected changes don't trigger false positives. This is useful for common changes like:

  • Randomized testimonials feeds
  • Sliders
  • Social (Twitter, Facebook, Pinterest, etc.) feeds
  • Advertising

For percent change, consider that a 1% change is like a 1000 pixel wide image shifting 10 pixels over.

You can adjust this setting later for individual tests.

Additional DOM element exclusion is in active development.

Excluded Updates

Autopilot checks for plugins, modules, and themes that are eligible for exclusion. Choose which should be excluded.

Autopilot Configuration screen - Exclude certain types of updates from Autopilot.

Click Refresh Updates to scan for available updates that can be excluded from Autopilot.

Select any that should be excluded, then click Save.

Excluded Web Elements

Add any CSS selectors that you want to exclude from the visual regression tests.

Autopilot Configuration screen - Exclude certain types of updates from Autopilot.

List the CSS selectors you want to exclude from VRT, using a comma or line break to separate elements in the list.

Click Save.

Configure Autopilot for Premium and Paid Plugins and Modules

Configure Autopilot for each individual premium and paid plugins and modules. Depending on the plugin, you may need to provide Autopilot with access or configure the plugin or module to work with Autopilot.

Enable Autopilot Email Notifications

Configure email notifications for Autopilot alerts and activity digests in your Personal Workspace settings:

Personal Workspace Settings include options for Autopilot email notifications

  1. Click the Gravatar in the upper right corner and click User Settings

  2. Click Notifications and choose your options in the Autopilot Email Notifications section:

    • Weekly Activity Digest: A weekly summary of Autopilot activity across all sites within the workspaces that have Autopilot enabled.
      • Digests are sent each Monday with information about the previous seven days.
    • Failed Visual Regression Tests: Real-time email notifications for failed visual regression tests for a given site.