Tasks

Below is the current list of supported tasks with details on their input parameters:

File

Copy

Copy a file from one location to another

• source: Source file path
• target: Target file path

Move

Move a file from one location to another

• source: Source file path
• target: Target file path

Vcs (version control)

Git.clone

Clones a copy of a repository from the repositoryPath and places it in the destinationPath

• repositoryPath: Path/URL for the repo to pull from
• destinationPath: Path to place the clone in

Git.pull (todo)

Pulls down the latest from the repository based on the destinationPath location

• destinationPath: Path of the cloned repository

Git.push (todo)

Network

Http.Get

Make a GET request to a remote resource. Has the option to write output to a file

• url: URL to request
• outputFile: Optional, file to output GET request results to

Package

Composer

Executes the Composer package build on the project base directory. Writes temp composer.json based on configuration in usher's config.json

• config: Composer configuration JSON
• composerPath: Path to the composer.phar

Phar

Builds a phar archive from the given directory

• stubFile: File to use as a stub in the archive (deprecated)
• target: Phar file to output (with path)

Internal

Param

Store an internal parameter/variable

• value: Value to assign
• name: Name of the parameter

Write

Write out a message to the console

• message: Message to output

Syntax

PhpLint

Runs a php -l on the default project directory

JsLint (todo)

Test

PhpUnit (todo)

Executes the PHPUnit tests in the given directory (or defaults to /tests under the project directory)

SimpleTest (todo)

Documentation

Phpdocumentor

Runs the phpdoc command plus whatever options are provided in the config.json file

Docblox

Runs the docblox command plus whatever options are provided in the config.json file

Contact

Email

Send an email to the given address(es) with the output from the execution