Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 2.26 KB

README.md

File metadata and controls

64 lines (41 loc) · 2.26 KB
Raw

Terminus Addons Installer Plugin

Build Status Actively Maintained

Terminus v3.x Compatible

Adds the addons-install command and sub-commands addons-install:list and addons-install:run <job> to Terminus. Use this Terminus Plugin to run workflows that configure themes & plugins.

Learn more about Terminus Plugins in the Terminus Plugins documentation

Configuration

These commands require no configuration

Commands

addons-install (alias install)

This is the base command. This command without any sub-commands will simply print the usage information and documentation.

addons-install:list (alias install:list)

Lists available jobs.

addons-install:run <job> (alias install:run)

Runs the specified job.

Note: Jobs will fail if a site is in SFTP mode and there are outstanding changes that have not be committed to the Pantheon repository.

Usage

  • terminus addons-install:list
  • terminus addons-install:run <site_id>.<env> <job> [--skip-db]

Installation

To install this plugin using Terminus 3:

terminus self:plugin:install terminus-addons-installer-plugin

Testing

This example project includes four testing targets:

  • composer lint: Syntax-check all php source files.
  • composer cs: Code-style check.
  • composer unit: Run unit tests with phpunit
  • composer functional: Run functional test with bats

To run all tests together, use composer test:all.

Note that prior to running the tests, you should first run:

  • composer install
  • composer install-tools

Help

Run terminus help addons-install for help.