This plugin joins a Slack room and sends a user-defined message, for example a "Build Succeeded" message.
| Field | Required? | Description |
|---|---|---|
webhook_url |
Yes | The URL to your Slack WebHook |
room |
No | Your Slack room name. Default - #php-censor |
username |
No | The name to send the message as. Default - PHP Censor |
icon |
No | The URL to the user icon or an emoji such as 👻. Default - The value configured on Slack's |
| WebHook setup | ||
message |
No | The message to send to the room. Default - `<%PROJECT_LINK% |
| #%BUILD_ID%> has finished for commit <%COMMIT_LINK% | %SHORT_COMMIT_ID% (%COMMITTER_EMAIL%)> on branch <%BRANCH_LINK% | %BRANCH%>` |
show_status |
No | Whether or not to append the build status as an attachment in slack. Default - true |
Send a message if the build fails:
failure:
slack_notify_step:
plugin: slack_notify
webhook_url: "https://hooks.slack.com/services/R212T827A/G983UY31U/aIp0yuW9u0iTqwAMOEwTg"
room: "#php-censor"
username: "PHP Censor"
icon: ":ghost:"
message: "%PROJECT_TITLE% - build %BUILD_ID% failed! :angry:"
show_status: falseSend a message if the build is successful:
success:
slack_notify_step:
plugin: slack_notify
webhook_url: "https://hooks.slack.com/services/R212T827A/G983UY31U/aIp0yuW9u0iTqwAMOEwTg"
room: "#php-censor"
username: "PHP Censor"
icon: ":ghost:"
message: "%PROJECT_TITLE% - build %BUILD_ID% succeeded! :smiley:"
show_status: falseSend a message every time the build runs:
complete:
slack_notify_step:
plugin: slack_notify
webhook_url: "https://hooks.slack.com/services/R212T827A/G983UY31U/aIp0yuW9u0iTqwAMOEwTg"
room: "#php-censor"
username: "PHP Censor"
icon: ":ghost:"
message: "%PROJECT_TITLE% - build %BUILD_ID% completed"
show_status: true