Skip to content

tideways.md

Latest commit

 

History

History
38 lines (29 loc) · 1.38 KB

tideways.md

File metadata and controls

38 lines (29 loc) · 1.38 KB
Raw

Tideways Recipe

require 'contrib/tideways.php';

Source

Configuration options

  • api_key (required): Check to "Project Settings" to find the API key necessary to authenticate the Create Event request.
  • name (optional): Name of the release, defaults to Deployer release name
  • name_prefix (optional): a string prefixed to version.
  • type (optional): Type of the event. Currently supports release and marker, defaults to release.
  • description (optional): More details about the release.
  • environment (optional): The environment this release is performed on, otherwise the default environment is used.
  • service (optional): The service this release is performed on, otherwise the default service of the project is used.
  • 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).
deploy.php
set('tideways', [
    'api_key' => 'Qm8JxL2...'
]);

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', 'deploy:tideways');