php-censor/docs/en/plugins/deployer.md
2017-07-18 20:54:24 +07:00

25 lines
778 B
Markdown

Plugin Deployer
===============
Triggers a deployment of the project to run via [Deployer](http://phpdeployment.org)
Configuration
-------------
### Options
* **webhook_url** [required, string] - The URL to your Deployer WebHook
* **reason** [optional, string] - Your deployment message. Default - PHP Censor 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
### Examples
```yaml
success:
deployer:
webhook_url: "https://deployer.example.com/deploy/QZaF1bMIUqbMFTmKDmgytUuykRN0cjCgW9SooTnwkIGETAYhDTTYoR8C431t"
reason: "PHP Censor Build #%BUILD% - %COMMIT_MESSAGE%"
update_only: true
```