Skip to content

tideways.md

Latest commit

 

History

History
43 lines (34 loc) · 1.5 KB

tideways.md

File metadata and controls

43 lines (34 loc) · 1.5 KB

Tideways Recipe

require 'contrib/tideways.php';

Source

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"'.
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.

deploy.php
after('deploy:success', 'deploy:tideways');