Updated Deployer (markdown)
parent
d5273beccd
commit
2c583ad31f
26
Deployer.md
26
Deployer.md
|
@ -1,16 +1,18 @@
|
|||
Triggers a deployment to run via Deployer(http://phpdeployment.org)
|
||||
Triggers a deployment of the project to run via [Deployer](http://phpdeployment.org)
|
||||
|
||||
### Configuration Options:
|
||||
**Configuration Options:**
|
||||
|
||||
* **remove** - Required - An array of files and / or directories to remove.
|
||||
| Field | Required? | Description |
|
||||
|-------|-----------|-------------|
|
||||
| `webhook_url` | Yes | The URL to your Deployer WebHook |
|
||||
| `reason` | No | Your deployment message. Default - PHPCI Build #%BUILD% - %COMMIT_MESSAGE% |
|
||||
| `update_only` | No | Whether the deployment should only be run if the currently deployed branches matches the one being build. Default - true
|
||||
|
||||
### Example Configuration:
|
||||
|
||||
```yml
|
||||
complete:
|
||||
clean_build:
|
||||
remove:
|
||||
- composer.json
|
||||
- composer.phar
|
||||
- config.dev.php
|
||||
Send a message if the build fails:
|
||||
```yaml
|
||||
success:
|
||||
deployer:
|
||||
webhook_url: "https://deployer.example.com/deploy/QZaF1bMIUqbMFTmKDmgytUuykRN0cjCgW9SooTnwkIGETAYhDTTYoR8C431t"
|
||||
reason: "PHPCI Build #%BUILD% - %COMMIT_MESSAGE%"
|
||||
upload_only: true
|
||||
```
|
Loading…
Reference in a new issue