slack.md

Slack recipe

Installing

Install recipes through composer:

composer require deployer/recipes --dev

Require slack recipe in your deploy.php file:
note: currently there is a bug in the autoloader detection requiring users to specify the full path (more info).

//require 'recipe/slack.php';
require 'vendor/deployer/recipes/recipe/slack.php';

Add hook on deploy:

before('deploy', 'slack:notify');

Configuration

• slack_webhook – slack incoming webhook url, required

  set('slack_webhook', 'https://hooks.slack.com/...');
  

• slack_title – the title of application, default {{application}}

• slack_text – notification message template, markdown supported

  set('slack_text', '_{{user}}_ deploying `{{branch}}` to *{{target}}*');
  

• slack_success_text – success template, default:

  set('slack_success_text', 'Deploy to *{{target}}* successful');
  

• slack_failure_text – failure template, default:

  set('slack_failure_text', 'Deploy to *{{target}}* failed');
  

• slack_color – color's attachment

• slack_success_color – success color's attachment

• slack_failure_color – failure color's attachment

Tasks

• slack:notify – send message to slack
• slack:notify:success – send success message to slack
• slack:notify:failure – send failure message to slack

Usage

If you want to notify only about beginning of deployment add this line only:

before('deploy', 'slack:notify');

If you want to notify about successful end of deployment add this too:

after('success', 'slack:notify:success');

If you want to notify about failed deployment add this too:

after('deploy:failed', 'slack:notify:failure');