deployer/docs/contrib/rollbar.md

55 lines
1.1 KiB
Markdown
Raw Normal View History

2020-10-02 00:11:13 +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');
```
* Config
* [`rollbar_comment`](#rollbar_comment)
* Tasks
* [`rollbar:notify`](#rollbarnotify) — Notifying Rollbar of deployment
## Config
### rollbar_comment
2020-11-16 10:56:42 +01:00
[Source](https://github.com/deployphp/deployer/search?q=%22rollbar_comment%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arollbar.php)
2020-10-02 00:11:13 +02:00
## Tasks
### rollbar:notify
2020-11-16 10:56:42 +01:00
[Source](https://github.com/deployphp/deployer/search?q=%22rollbar%3Anotify%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arollbar.php)
2020-10-02 00:11:13 +02:00