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.

  1. Switch to the Workspace for the site's Organization to work with Autopilot before you continue.

    Autopilot Overview page shows sites available for Autopilot

  2. Commit any staged changes that have not been committed before you continue if the site is in SFTP mode.

  3. Click the Autopilot icon in the Global Primary Navigation.

  4. View the list of sites for which Autopilot is available in the All Sites column of the Sites table.

  5. Click Activate in the row of the desired site.

    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 any unsaved changes.

Autopilot Setup Wizard

The Autopilot setup wizard automatically displays after you activate Autopilot for a site. You must complete all items in the Configuration, Schedule, and Visual Review steps.

Configuration

  1. Use the On/Off toggles to choose which features and elements should be tracked or excluded from updates.

    Any elements that Autopilot detects as available for exclusion will be listed in each category (Modules, Plugins, Themes).

  2. Click Manage Excluded Updates then the Exclude button on the element's row to exclude it from Autopilot updates.

  3. Click Continue.

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

Schedule

  1. Set the Deployment Destination to the desired environment:

    • Dev
    • Test
    • Live
  2. Set the Update Frequency to schedule Autopilot to run:

    • Never (Update Manually)
    • Weekly
    • Monthly
  3. Select the Sync Live Environment checkbox to sync environments.

    The Sync Environment feature syncs your Live environment to your Dev environment before Autopilot performs updates. Your databases and files will be synced, but not your code. If the Dev code does not match the Live code, Autopilot will use the code in the Dev environment.

    Autopilot Setup Wizard Schedule

  4. Click Continue to choose pages for screenshot comparison tests.

Visual Review

  1. 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.

  2. Click Save to initialize Autopilot on the Site.

  3. 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

  1. Navigate to the Autopilot page of the Workspace > click Actions > 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.

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

Update Scope

Use the On/Off toggle 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.

Update Destination & Frequency

You can determine how often Autopilot runs and select where you want successful updates deployed in the Destination and Frequency section.

Some selection options are grayed out for customers with Gold plans. Only customers with Platinum and Diamond plans have the ability to choose a setting for each option.

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

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

    • Dev
    • Test
    • Live
  2. Set the Update Frequency to schedule Autopilot to run:

    • Never (Update Manually)
    • Weekly
    • Monthly
  3. Select the Sync Live Environment checkbox to sync environments.

    The Sync Environment feature syncs your Live environment to your Dev environment before Autopilot performs updates. Your databases and files will be synced, but not your code. If the Dev code does not match the Live code, Autopilot will use the code in the Dev environment.

  4. Click Save to save the changes.

Update Visual Test Screenshots

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

Autopilot Configuration - Visual Test Screenshots

  1. Click Add to add more pages.

  2. 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. You can choose what you would like to be excluded.

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

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

  2. Select updates that should be excluded and then click Save.

Excluded Web Elements

You can add any CSS selectors that you want to exclude from the visual regression tests.

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

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

  2. 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.