deployer/docs/contrib/rollbar.md

60 lines
1.0 KiB
Markdown
Raw Normal View History

2021-09-26 15:25:58 +02:00
<!-- DO NOT EDIT THIS FILE! -->
<!-- Instead edit contrib/rollbar.php -->
<!-- Then run bin/docgen -->
# rollbar
[Source](/contrib/rollbar.php)
## Installing
Add to your _deploy.php_
```php
require 'contrib/rollbar.php';
```
## Configuration
- `rollbar_token` access token to rollbar api
- `rollbar_comment` comment about deploy, default to
```php
set('rollbar_comment', '_{{user}}_ deploying `{{branch}}` to *{{target}}*');
```
- `rollbar_username` rollbar user name
## Usage
Since you should only notify Rollbar channel of a successful deployment, the `rollbar:notify` task should be executed right at the end.
```php
after('deploy', 'rollbar:notify');
```
## Configuration
### rollbar_comment
[Source](https://github.com/deployphp/deployer/blob/master/contrib/rollbar.php#L33)
```php title="Default value"
'_{{user}}_ deploying `{{branch}}` to *{{target}}*'
```
## Tasks
### rollbar:notify
[Source](https://github.com/deployphp/deployer/blob/master/contrib/rollbar.php#L36)
Notifying Rollbar of deployment.