Created deploy.finish (markdown)

ni-richard 2019-09-12 11:32:10 +02:00
parent be8313e55c
commit a14fec3e18

24
deploy.finish.md Normal file

@ -0,0 +1,24 @@
* **Description**: The default action to [deploy.start](https://github.com/avatao-content/baseimage-tutorial-framework/wiki/deploy.start) is to restart a service and deployment is considered successful when the process stays alive or exits with an expected status code.
* **Subscribers**: [DeployHandler](https://github.com/avatao-content/baseimage-tutorial-framework/wiki/DeployHandler)
```json
{
"key": "deploy.finish",
"scope": "websocket"
}
```
| Parameter | Type | Required | Description |
| ------------ |:--------:|:------------------:| --------------------------- |
| *error* | `string` | | The presence of this field determines the deployment's status. When omitted, it is considered successful, otherwise you can state the reason of the failure here. By default, this is the message returned by the supervisor daemon. |
***
**Example**:
```json
{
"key": "deploy.finish",
"scope": "websocket",
"error": "Syntax error."
}
```