Improved docs

This commit is contained in:
Dmitry Khomutov 2016-07-19 15:12:28 +06:00
commit 320a249153
49 changed files with 454 additions and 193 deletions

View file

@ -1,12 +1,19 @@
Plugin Deployer
---------------
Triggers a deployment of the project to run via [Deployer](http://phpdeployment.org)
**Configuration Options:**
Configuration
=============
### Options
* **webhook_url** [required, string] - The URL to your Deployer WebHook
* **reason** [optional, string] - Your deployment message. Default - PHPCI Build #%BUILD% - %COMMIT_MESSAGE%
* **update_only** [optional, bool, true|false] - Whether the deployment should only be run if the currently deployed branches matches the one being built. Default - true
### Example
### Examples
```yaml
success:
deployer: