Skip to main content
Version: 7.x

Workplace Recipe

require 'contrib/workplace.php';

Source

This recipes works with Custom Integrations and Publishing Bots.

Add hook on deploy:

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

Configuration​

  • workplace_webhook - incoming workplace webhook required

    // With custom integration
    set('workplace_webhook', 'https://graph.facebook.com/<GROUP_ID>/feed?access_token=<ACCESS_TOKEN>');

    // With publishing bot
    set('workplace_webhook', 'https://graph.facebook.com/v3.0/group/feed?access_token=<ACCESS_TOKEN>');

    // Use markdown on message
    set('workplace_webhook', 'https://graph.facebook.com/<GROUP_ID>/feed?access_token=<ACCESS_TOKEN>&formatting=MARKDOWN');

  • workplace_text - notification message

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

  • workplace_success_text – success template, default:

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

  • workplace_failure_text – failure template, default:

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

  • workplace_edit_post – whether to create a new post for deploy result, or edit the first one created, default creates a new post:

    set('workplace_edit_post', false);

Usage​

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

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

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

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

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

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

Configuration​

workplace_text​

Source

Deploy message

Default value
'_{{user}}_ deploying `{{branch}}` to *{{target}}*'

workplace_success_text​

Source

Default value
'Deploy to *{{target}}* successful'

workplace_failure_text​

Source

Default value
'Deploy to *{{target}}* failed'

workplace_edit_post​

Source

By default, create a new post for every message

Default value
false

Tasks​

workplace:notify​

Source

Notifies Workplace.

workplace:notify:success​

Source

Notifies Workplace about deploy finish.

workplace:notify:failure​

Source

Notifies Workplace about deploy failure.