Download the PHP package digital-pacific/ci-toolbox without Composer
On this page you can find all versions of the php package digital-pacific/ci-toolbox. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download digital-pacific/ci-toolbox
More information about digital-pacific/ci-toolbox
Files in digital-pacific/ci-toolbox
Package ci-toolbox
Short Description This toolbox combines other various popular PHP tools and runs them easily with Rabbit
License Apache 2.0
Homepage https://github.com/DigitalPacific/ci-toolbox.git
Informations about the package ci-toolbox
ci-toolbox
This toolbox contains popular PHP utilities used to ensure stability for continuous integration.
Within this package you will find a rabbit.yaml file which is used to run all the included utilities. Rabbit is an easy to install Python application https://github.com/ouijan/rabbit.
Install - Package
Require the package in your composer.json file and run the composer install command to install it:
Install - Rabbit
Rabbit is a Python module that can be installed via pip, visit Rabbit's repo for installation instructions.
Once Rabbit has been installed copy the appropriate yaml file from the rabbit folder into the root directory of your code. Rename the file rabbit.yaml.
If everything is installed correctly run:
Which should display:
Install - Patch
This toolbox is just a collection of other utilities that have their own dependencies. One of those dependencies is a program called patch.
A patch program is already installed on OSX
Centos Installation:
Ubunutu Installation:
Usage
This toolbox is just a collection of popular PHP utilities with a convenient way to run them using Rabbit.
There are 5 utilities in this toolbox:
The way that Rabbit is setup is to run each of these utilities individually or as a suite.
If you are importing this package into an existing project it is recommended that first run each utility individually, fixing up problems that are reported and tweaking the rabbit.yaml file to suite your projects needs before running the the entire suite of utilities.
Here is an example of how to run an individual utility:
Once you finished running the utilities individually you can run the entire suite by using:
This command runs each individual utility and exits with that utilities exit code. So if during the execution of this command the first utility has an exit code that is not 0 no other utilities will run after it. This is useful in a continuous integration environment where a script could call this single command to run the entire suite and be confident that if the suite exits with a code of 0 then everything has passed.
If you need a reminder of the different Rabbit commands already setup, you can either view the rabbit.yaml file or run:
Bitbucket Pipeline
Bitbucket has a new feature called Pipelines that this toolbox can be utilised for in your PHP projects.
A docker image has been created specifically for use with this toolbox and can be found at php-ci-toolbox.
An example bitbucket-pipelines.yml file for running this ci-toolbox is below.
All versions of ci-toolbox with dependencies
jakub-onderka/php-parallel-lint Version 0.9.2
jakub-onderka/php-console-highlighter Version 0.3.2
squizlabs/php_codesniffer Version 2.6.0
sebastian/phpcpd Version 2.0.4
phpmd/phpmd Version 2.4.3
phpunit/phpunit Version 4.8.*