php-censor/docs/en/plugins/deployer.md

24 lines
767 B
Markdown
Raw Normal View History

2016-07-19 11:12:28 +02:00
Plugin Deployer
---------------
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
=============
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
* **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
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"
reason: "PHPCI Build #%BUILD% - %COMMIT_MESSAGE%"
update_only: true
```