pantheon-systems/terminus-composer-plugin

Composer - A Terminus plugin for running Composer commands on a Pantheon site

Installs: 26 283

Dependents: 0

Suggesters: 0

Security: 0

Stars: 7

Watchers: 9

Forks: 6

Open Issues: 3

Language:Shell

Type:terminus-plugin

1.1.0 2019-02-22 16:36 UTC

This package is auto-updated.

Last update: 2021-03-26 20:00:41 UTC


README

CircleCI Terminus v1.x Compatible Terminus v0.x Compatible

Terminus Plugin to run Composer commands on Pantheon sites.

Adds a command 'composer' to Terminus 1.x which you can use just like 'drush' or 'wp'. For a version that works with Terminus 0.x, see the 0.x branch.

This project is a simplified version of the original Terminus Composer Plugin by Brian Thompson, updated for Terminus 1.x.

Configuration

If using Composer to manage your site on Pantheon, it is best to start with the appropriate relocated document root Composer example project:

Using Composer to manage standard sites on Pantheon not started with these upstreams (or a similar variant thereof) is not recommended. Ensure that your site's pantheon.yml contains web_docroot: true. See Serving Sites from the Web Subdirectory for more information.

Examples

  • terminus composer my-script

Caution

Commands such as composer require and composer update take a lot of memory, and are likely to fail when run on the platform. Some problematic examples appear below:

  • terminus composer my-site.dev -- composer config repositories.drupal composer https://packages.drupal.org/8
  • terminus composer my-site.dev -- require drupal/media
  • terminus composer my-site.dev -- update

Installation

For help installing, see Manage Plugins

mkdir -p ~/.terminus/plugins
composer create-project --no-dev -d ~/.terminus/plugins pantheon-systems/terminus-composer-plugin:~1

Help

Run terminus help composer for help.