Skip to main content
Version: 7.x

Discord Recipe

require 'contrib/discord.php';

Source

Installing​

Add hook on deploy:

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

Configuration​

  • discord_channel – Discord channel ID, required

  • discord_token – Discord channel token, required

  • discord_notify_text – notification message template, markdown supported, default:

    :​information_source: **{{user}}** is deploying branch `{{branch}}` to _{{target}}_

  • discord_success_text – success template, default:

    :​white_check_mark: Branch `{{branch}}` deployed to _{{target}}_ successfully

  • discord_failure_text – failure template, default:

    :​no_entry_sign: Branch `{{branch}}` has failed to deploy to _{{target}}_

Usage​

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

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

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

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

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

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

Configuration​

discord_webhook​

Source

Default value
return 'https://discordapp.com/api/webhooks/{{discord_channel}}/{{discord_token}}/slack';

discord_notify_text​

Source

Deploy messages

Default value
return [
'text' => parse(':​information_source: **{{user}}** is deploying branch `{{branch}}` to _{{target}}_'),
];

discord_success_text​

Source

Default value
return [
'text' => parse(':​white_check_mark: Branch `{{branch}}` deployed to _{{target}}_ successfully'),
];

discord_failure_text​

Source

Default value
return [
'text' => parse(':​no_entry_sign: Branch `{{branch}}` has failed to deploy to _{{target}}_'),
];

discord_message​

Source

The message

Default value
'discord_notify_text'

Tasks​

discord_send_message​

Source

Helpers

discord:test​

Source

Tests messages.

Tasks

discord:notify​

Source

Notifies Discord.

discord:notify:success​

Source

Notifies Discord about deploy finish.

discord:notify:failure​

Source

Notifies Discord about deploy failure.