Automating and Integrating your Pantheon Workflow with Quicksilver Platform Hooks
Learn how to use Quicksilver to automate your deployment workflow.
Hook into platform workflows to automate your Pantheon workflow. Tell us which script you want to run, and we'll run it automatically every time you or another team member triggers the corresponding workflow. View (and contribute) to a growing set of example scripts. Find examples to enable functionality like chat-ops, database sanitization, deployment logging, and automated testing operations with a CI server.
Set up existing scripts and write your own with help from our experts. Pantheon delivers custom workshops to help development teams master our platform and improve their internal DevOps.
For example, committing a
pantheon.yml file with the following contents to the root of your site's code repository with the script adapted from slack_notification will post to Slack every time you deploy:
api_version: 1 workflows: deploy: after: - type: webphp description: Post deployment notification to Slack script: private/scripts/slack_deploy_notification.php
If you add the following after the previous snippet, we'll also run that script to automatically log the deployment to New Relic:
- type: webphp description: Log to New Relic script: private/scripts/new_relic_deploy.php
Workflow and Stage
Specify the workflows you want to hook into (e.g.
sync_code), the workflow stage (
after) and the location of the script relative to root of your site's docroot.
Script Type and Location
Quicksilver currently supports
webphp scripting, which runs a PHP script via the same runtime environment as the website itself. PHP scripts are subject to the same limits as any code on the platform, like timeouts, and cannot be batched. In the future we may add additional types.
We recommend setting up a dedicated directory in the docroot (e.g.
private/scripts) for tracking these files. If your site uses a nested docroot, the scripts directory needs to be located in the
web subdirectory of your site's code repository (e.g.
You can hook into the following workflows:
|Workflow||Description||Location of webphp script runtime||Notes|
||Clear CMS and Edge Cache|
||Clone database between environments||target (to_env)|
||Deploy code to Test or Live||target|
||Push code via Git or commit OSD/SFTP changes via Pantheon Dashboard||Dev or Multidev|
|Create Multidev environment||Multidev||
Debugging via Terminus
Use the following Terminus commands for debugging Quicksilver.
Stream New Workflows to the Console
Follow the workflow activity of your site with
terminus workflow:watch <site>.
Explore Previous Workflows
List and show previous workflows and their corresponding Quicksilver operations with the following commands:
terminus workflow:list <site>
terminus workflow:info:logs <site> --id=<workflow>
terminus workflow:info:operations <site> --id=<workflow>
terminus workflow:info:status <site> --id=<workflow>
If you want to hook into deploy workflows, you'll need to deploy your
pantheon.yml into an environment first. Likewise, if you are adding new operations or changing the script an operation will target, the deploy containing those adjustments to
pantheon.yml will not self-referentially exhibit the new behavior. Only subsequent deploys will be affected.
MultiDev Creation Hook Does Not Run When Expected
Quicksilver hooks for the
create_cloud_development_environment workflow will not be detected when creating a Multidev environment if the
pantheon.yml file does not exist on the Dev environment. As a workaround, commit the
pantheon.yml file on Dev before creating a Multidev environment.
Deploying Configuration Changes or Quicksilver Hooks to Multidev
pantheon.yml file does not exist on the Dev environment, configuration changes will not be detected when creating a Multidev environment. As a workaround, make some modification the
pantheon.yml file and re-commit to the Multidev environment. You will then receive a notice indicating configuration changes have been detected and applied to the Multidev environment:
remote: remote: PANTHEON NOTICE: remote: remote: Changes to `pantheon.yml` detected. remote: remote: Successfully applied `pantheon.yml` to the 'new-feature' environment. remote: remote: