Skip to main content
Version: 7.x

yammer

Source

Yammer recipe

Installing

Require yammer recipe in your deploy.php file:

require 'contrib/yammer.php';

Add hook on deploy:

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

Configuration

  • yammer_url โ€“ The URL to the message endpoint, default is https://www.yammer.com/api/v1/messages.json
  • yammer_token (required) โ€“ Yammer auth token
  • yammer_group_id (required) - Group ID
  • yammer_title โ€“ the title of application, default {{application}}
  • yammer_body โ€“ notification message template, default:
    <em>{{user}}</em> deploying {{branch}} to <strong>{{target}}</strong>
  • yammer_success_body โ€“ success template, default:
    Deploy to <strong>{{target}}</strong> successful
  • yammer_failure_body โ€“ failure template, default:
    Deploy to <strong>{{target}}</strong> failed

Usage

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

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

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

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

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

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

Configuration

yammer_url

Source

Default value
'https://www.yammer.com/api/v1/messages.json'

yammer_title

Source

Title of project

yammer_body

Source

Deploy message

Default value
'<em>{{user}}</em> deploying {{branch}} to <strong>{{target}}</strong>'

yammer_success_body

Source

Default value
'Deploy to <strong>{{target}}</strong> successful'

yammer_failure_body

Source

Default value
'Deploy to <strong>{{target}}</strong> failed'

Tasks

yammer:notify

Source

Notifies Yammer.

yammer:notify:success

Source

Notifies Yammer about deploy finish.

yammer:notify:failure

Source

Notifies Yammer about deploy failure.



Support Deployer โค๏ธ

Hello, my name is Anton Medvedev (@antonmedv). I'm the creator of the Deployer. I maintain this open source project in my spare time. Supporters on GitHub give me extra motivation to work on the project.

Consider supporting Deployer via GitHub Sponsors.

Also, please, nominate me for GitHub Stars award. Thanks!