Ms-teams Recipe

require 'contrib/ms-teams.php';

Source

Installing

Require ms-teams recipe in your deploy.php file: Setup:

1. Open MS Teams
2. Navigate to Teams section
3. Select existing or create new team
4. Select existing or create new channel
5. Hover over channel to get three dots, click, in menu select "Connectors"
6. Search for and configure "Incoming Webhook"
7. Confirm/create and copy your Webhook URL
8. Setup deploy.php Add in header:

require 'contrib/ms-teams.php';
set('teams_webhook', 'https://outlook.office.com/webhook/...');

Add in content:

before('deploy', 'teams:notify');
after('deploy:success', 'teams:notify:success');
after('deploy:failed', 'teams:notify:failure');

9.) Sip your coffee

Configuration

• teams_webhook – teams incoming webhook url, required
  Copy

  set('teams_webhook', 'https://outlook.office.com/webhook/...');
  

• teams_title – the title of application, default {{application}}
• teams_text – notification message template, markdown supported
  Copy

  set('teams_text', '_{{user}}_ deploying `{{what}}` to *{{where}}*');
  

• teams_success_text – success template, default:
  Copy

  set('teams_success_text', 'Deploy to *{{where}}* successful');
  

• teams_failure_text – failure template, default:
  Copy

  set('teams_failure_text', 'Deploy to *{{where}}* failed');
  

• teams_color – color's attachment
• teams_success_color – success color's attachment
• teams_failure_color – failure color's attachment

Usage

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

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

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

after('deploy:success', 'teams:notify:success');

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

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

Configuration

teams_title

Source

Title of project

return get('application', 'Project');

teams_failure_continue

Source

Allow Continue on Failure

false

teams_text

Source

Deploy message

'_{{user}}_ deploying `{{what}}` to *{{where}}*'

teams_success_text

Source

'Deploy to *{{where}}* successful'

teams_failure_text

Source

'Deploy to *{{where}}* failed'

teams_color

Source

Color of attachment

'#4d91f7'

teams_success_color

Source

'#00c100'

teams_failure_color

Source

'#ff0909'

Tasks

teams:notify {#teams-notify}

Source

Notifies Teams.

teams:notify:success {#teams-notify-success}

Source

Notifies Teams about deploy finish.

teams:notify:failure {#teams-notify-failure}

Source

Notifies Teams about deploy failure.