pantheon-systems / terminus-addons-installer-plugin
Allows Terminus to trigger workflows on the platform that configure themes & plugins.
Installs: 2 139
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 7
Forks: 1
Open Issues: 1
Type:terminus-plugin
Requires (Dev)
- phpunit/phpunit: ^9
- squizlabs/php_codesniffer: ^3.6
- symfony/yaml: ^5
This package is auto-updated.
Last update: 2024-10-11 01:24:59 UTC
README
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 phpunitcomposer 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.