Skip to content

Add Tideways deployment notification task #4123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
peterjaap wants to merge 4 commits into
base: master
Choose a base branch
from
+183 −0
Open

Add Tideways deployment notification task #4123

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
94c5ebc
Add Tideways deployment notification task
peterjaap Oct 10, 2025
8b6d496
update docs
peterjaap Oct 10, 2025
89b45c6
Add Tideways deployment hook after successful deploy
peterjaap Oct 10, 2025
9029738
Refactor Tideways deployment notification logic
peterjaap Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update docs
  • Loading branch information
@peterjaap
peterjaap committed Oct 10, 2025
commit 8b6d496a30a7c5f43fd3f8244e17904545e7adcd
1 change: 1 addition & 0 deletions docs/contrib/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
* [Slack Recipe](/docs/contrib/slack.md)
* [Supervisord-monitor Recipe](/docs/contrib/supervisord-monitor.md)
* [Telegram Recipe](/docs/contrib/telegram.md)
* [Tideways Recipe](/docs/contrib/tideways.md)
* [Webpack_encore Recipe](/docs/contrib/webpack_encore.md)
* [Workplace Recipe](/docs/contrib/workplace.md)
* [Yammer Recipe](/docs/contrib/yammer.md)
Expand Down
43 changes: 43 additions & 0 deletions docs/contrib/tideways.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<!-- DO NOT EDIT THIS FILE! -->
<!-- Instead edit contrib/tideways.php -->
<!-- Then run bin/docgen -->

# Tideways Recipe

```php
require 'contrib/tideways.php';
```

[Source](/contrib/tideways.php)



### Configuration options
- **api_key** *(required)*: Tideways API key for authentication.
- **version** *(required)*: A version identifier for this release. Can be a version number, a commit hash etc. (Default is set to git log -n 1 --format="%h".)
- **environment** *(optional)*: The environment you're deploying to. Defaults to 'production'.
- **service** *(optional)*: The service name for the release. Defaults to 'web'.
- **compare_after_minutes** *(optional)*: Time in minutes to compare performance before/after release. Defaults to 90.
- **project** *(optional)*: Project name/path for the description field.
- **description** *(optional)*: Custom description for the release.
- **tideways_server** *(optional)*: Tideways server URL. Defaults to 'https://app.tideways.io'.
- **git_version_command** *(optional)*: The command that retrieves the git version information. Defaults to 'git log -n 1 --format="%h"'.
```php
deploy.php
set('tideways', [
'api_key' => 'your-api-key',
'version' => '',
'environment' => 'production',
'service' => 'web',
'compare_after_minutes' => 90,
]);
```
### Suggested Usage
Since you should only notify Tideways of a successful deployment, the deploy:tideways task should be executed right at the end.
```php
deploy.php
after('deploy:success', 'deploy:tideways');
```



Loading