Skip to content

Commit ff46919

Browse files
author
Jonathan Visser
committed
Add documentation for Tideways recipe
1 parent 870e4b1 commit ff46919

2 files changed

Lines changed: 39 additions & 0 deletions

File tree

docs/contrib/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
* [Slack Recipe](/docs/contrib/slack.md)
3131
* [Supervisord-monitor Recipe](/docs/contrib/supervisord-monitor.md)
3232
* [Telegram Recipe](/docs/contrib/telegram.md)
33+
* [Tideways Recipe](/docs/contrib/tideways.md)
3334
* [Webpack_encore Recipe](/docs/contrib/webpack_encore.md)
3435
* [Workplace Recipe](/docs/contrib/workplace.md)
3536
* [Yammer Recipe](/docs/contrib/yammer.md)

docs/contrib/tideways.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!-- DO NOT EDIT THIS FILE! -->
2+
<!-- Instead edit contrib/tideways.php -->
3+
<!-- Then run bin/docgen -->
4+
5+
# Tideways Recipe
6+
7+
```php
8+
require 'contrib/tideways.php';
9+
```
10+
11+
[Source](/contrib/tideways.php)
12+
13+
14+
15+
### Configuration options
16+
- **api_key** *(required)*: Check to "Project Settings" to find the API key necessary to authenticate the Create Event request.
17+
- **name** *(optional)*: Name of the release, defaults to Deployer release name
18+
- **name_prefix** *(optional)*: a string prefixed to version.
19+
- **type** *(optional)*: Type of the event. Currently supports `release` and `marker`, defaults to `release`.
20+
- **description** *(optional)*: More details about the release.
21+
- **environment** *(optional)*: The environment this release is performed on, otherwise the default environment is used.
22+
- **service** *(optional)*: The service this release is performed on, otherwise the default service of the project is used.
23+
- **compareAfterMinutes** *(optional)*: Defaults to 90 minutes. Specifies the timeframes around the event for which the performance will be compared. Supported values are between 5 minutes and 1440 minutes (one day).
24+
```php
25+
deploy.php
26+
set('tideways', [
27+
'api_key' => 'Qm8JxL2...'
28+
]);
29+
```
30+
### Suggested Usage
31+
Since you should only notify Tideways of a successful deployment, the deploy:tideways task should be executed right at the end.
32+
```php
33+
deploy.php
34+
after('deploy', 'deploy:tideways');
35+
```
36+
37+
38+

0 commit comments

Comments
 (0)