deployer/docs/contrib/raygun.md

49 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/raygun.php -->
<!-- Then run bin/docgen -->
# raygun
[Source](/contrib/raygun.php)
2021-11-06 19:02:51 +01:00
2021-09-26 15:25:58 +02:00
## Installing
Add to your _deploy.php_
```php
require 'contrib/raygun.php';
```
## Configuration
- `raygun_api_key` the API key of your Raygun application
- `raygun_version` the version of your application that this deployment is releasing
- `raygun_owner_name` the name of the person creating this deployment
- `raygun_email` the email of the person creating this deployment
- `raygun_comment` the deployment notes
- `raygun_scm_identifier` the commit that this deployment was built off
- `raygun_scm_type` - the source control system you use
## Usage
To notify Raygun of a successful deployment, you can use the 'raygun:notify' task after a deployment.
```php
after('deploy', 'raygun:notify');
```
## Tasks
### raygun:notify
[Source](https://github.com/deployphp/deployer/blob/master/contrib/raygun.php#L34)
2021-11-08 22:59:39 +01:00
Notifies Raygun of deployment.
2021-09-26 15:25:58 +02:00