pantheon-systems/terminus-autopilot-plugin

Configure and manage Autopilot via Terminus commands.

0.1.2 2023-06-20 13:42 UTC

Requires (Dev)

• composer/composer: ^2.4
• kint-php/kint: ^4.2
• pantheon-systems/terminus: ^3.1
• phpunit/phpunit: ^9
• squizlabs/php_codesniffer: ^3.6
• tm/tooly-composer-script: ^1.4

MIT

README

Autopilot

Pantheon's Autopilot:

• Automatically detects when new updates are available
• Performs the updates in an isolated Multidev environment
• Tests the updates with automated visual regression testing (VRT)
• Optionally deploys the updates

You can perform comprehensive Autopilot functions through your Dashboard. Refer to the Autopilot guide for more information.

Site Compatibility

Review the Autopilot Site Compatibility documentation on Pantheon to ensure that your site is compatible with Autopilot.

Plugin Functionality

Terminus Autopilot Plugin Requirements

Autopilot requires the following:

• A site with Autopilot available
• Terminus 3

Terminus Autopilot Plugin Functionality

The Terminus Autopilot plugin does not currently provide the following functionality:

• Selection of specific modules, themes, or Custom Upstreams for updates
• Management of excluded updates

Installation

Run the command below to install the Terminus Autopilot plugin.

terminus self:plugin:install terminus-autopilot-plugin

Terminus Autopilot Commands

This section provides currently supported commands for the Terminus Autopilot plugin.

Activate or Deactivate Autopilot

You can activate for deactivate Autopilot for a specific site name or ID.

To activate a site:

site:autopilot:activate {SITE_NAME|SITE_ID}

To deactivate a site:

site:autopilot:deactivate {SITE_NAME|SITE_ID}

Get the Autopilot Destination Environment

You can use the command below to get the destination environment in which Autopilot is currently running.

site:autopilot:deployment-destination {SITE_NAME|SITE_ID}

Set the Autopilot Destination Environment

You can use the command below to set the destination environment for Autopilot.

site:autopilot:deployment-destination {SITE_NAME|SITE_ID} {{ENV}}

Get the Environment Syncing Status

You can use the command below to get the status of environment syncing.

site:autopilot:env-sync {SITE_NAME|SITE_ID}

Enable or Disable Environment Syncing

You can explicitly set environment syncing. This syncs the target Autopilot environment to the Live environment before applying updates in an Autopilot cycle.

To enable environment syncing:

site:autopilot:env-sync:enable

To disable environment syncing:

site:autopilot:env-sync:disable

Get Autopilot Frequency

You can use the command below to get the frequency at which Autopilot currently runs.

site:autopilot:frequency {SITE_NAME|SITE_ID}

Set Autopilot Frequency

You can use the command below to set the frequency at which Autopilot runs. Valid options are:

• daily (for Platinum sites and above)
• weekly
• monthly
• manual

site:autopilot:frequency {SITE_NAME|SITE_ID} {FREQUENCY}