pantheon-quicksilver/drush-config-import

Importing drupal configuration changes from .yml files with drush.

dev-main 2021-10-28 21:30 UTC

Requires

• composer/installers: ~1.0

MIT

README

This example will show you how to integrate Drush commands into your Quicksilver operations, with the practical outcome of importing configuration changes from .yml files . You can use the method shown here to run any Drush command you like.

Note that with the current webphp type operations, your timeout is limited to 120 seconds, so long-running operations should be avoided for now.

Requirements

While these scripts can be downloaded individually, they are meant to work with Composer. See the installation in the next section.

• Quicksilver script projects and the script name itself should be consistent in naming convention.
• README should include a recommendation for types of hooks and stages that the script should run on.
  • For example, "This script should run on clone_database and the after stage.
  • Provide a snippet that can be pasted into the pantheon.yml file.

Installation

This project is designed to be included from a site's composer.json file, and placed in its appropriate installation directory by Composer Installers.

In order for this to work, you should have the following in your composer.json file:

{
  "require": {
    "composer/installers": "^1"
  },
  "extra": {
    "installer-paths": {
      "web/private/scripts/quicksilver": ["type:quicksilver-script"]
    }
  }
}

The project can be included by using the command:

composer require pantheon-quicksilver/drush-config-import:^1

If you are using one of the example PR workflow projects (Drupal 8, Drupal 9, WordPress) as a starting point for your site, these entries should already be present in your composer.json.

Note that automating this step may not be appropriate for all sites. Sites on which configuration is edited in the live environment may not want to automatically switch to configuration stored in files. For more information, see https://www.drupal.org/documentation/administer/config

Optionally, you may want to use the terminus workflow:watch command to get immediate debugging feedback.

Example pantheon.yml

Here's an example of what your pantheon.yml would look like if this were the only Quicksilver operation you wanted to use:

api_version: 1

workflows:
  deploy:
    after:
      - type: webphp
        description: Import configuration from .yml files
        script: private/scripts/quicksilver/drush-config-import/drush-config-import.php