vfalconi/terminus-ci-tools

Some tools for running Terminus in a CI pipeline

0.1.1 2025-08-08 03:52 UTC

Requires (Dev)

• phpunit/phpunit: ^9
• squizlabs/php_codesniffer: ^3.6
• symfony/yaml: ^5

MIT

README

Configuration

These commands require no configuration

Usage

terminus checkEnv -- <site>.<test|live>
# throws an exception if the environment has nothing to deploy
# returns the string 'deployable' otherwise

Installation

mkdir -p $HOME/terminus/local_plugins
git clone https://github.com/vfalconi/terminus-ci-tools $HOME/terminus/local_plugins/terminus-ci-tools
terminus self:plugin:install $HOME/terminus/local_plugins/terminus-ci-tools

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.

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

• composer install
• composer install-tools