2016-07-19 11:12:28 +02:00
|
|
|
Plugin Deployer
|
2017-01-04 13:22:20 +01:00
|
|
|
===============
|
2016-07-19 11:12:28 +02:00
|
|
|
|
2016-07-17 16:20:35 +02:00
|
|
|
Triggers a deployment of the project to run via [Deployer](http://phpdeployment.org)
|
|
|
|
|
|
2016-07-19 11:12:28 +02:00
|
|
|
Configuration
|
2017-01-04 13:22:20 +01:00
|
|
|
-------------
|
2016-07-19 11:12:28 +02:00
|
|
|
|
2016-07-17 16:20:35 +02:00
|
|
|
### Options
|
2016-07-19 11:12:28 +02:00
|
|
|
|
2016-07-17 16:20:35 +02:00
|
|
|
* **webhook_url** [required, string] - The URL to your Deployer WebHook
|
2016-07-19 13:05:02 +02:00
|
|
|
* **reason** [optional, string] - Your deployment message. Default - PHP Censor Build #%BUILD% - %COMMIT_MESSAGE%
|
2017-07-18 15:54:24 +02:00
|
|
|
* **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
|
2016-07-17 16:20:35 +02:00
|
|
|
|
2016-07-19 11:12:28 +02:00
|
|
|
### Examples
|
|
|
|
|
|
2016-07-17 16:20:35 +02:00
|
|
|
```yaml
|
|
|
|
|
success:
|
|
|
|
|
deployer:
|
|
|
|
|
webhook_url: "https://deployer.example.com/deploy/QZaF1bMIUqbMFTmKDmgytUuykRN0cjCgW9SooTnwkIGETAYhDTTYoR8C431t"
|
2016-07-19 13:05:02 +02:00
|
|
|
reason: "PHP Censor Build #%BUILD% - %COMMIT_MESSAGE%"
|
2016-07-17 16:20:35 +02:00
|
|
|
update_only: true
|
|
|
|
|
```
|
