Slack Messaging
ActionsTags
(2)A GitHub Action for sending (and updating) messages of any layout and formatting from GitHub Actions to Slack. Inspired by Slack Notify Build.
A Slack bot token is required to use this action, and the associated app must be granted permission to post in the channel, private group or DM you specify.
uses: wearerequired/slack-messaging-action@v2
with:
bot_token: ${{ secrets.SLACK_BOT_TOKEN }}
channel: deployments
payload: >-
{
"icon_emoji": ":rocket:",
"username": "Deployer",
"text": "Deployment finished.",
"attachments": [
{
"author_name": "${{ github.event.sender.login }}",
"author_link": "${{ github.event.sender.html_url }}",
"author_icon": "${{ github.event.sender.avatar_url }}",
"color": "good",
"fields": [
{
"title": "Revision",
"value": "<https://github.com/${{ github.repository }}/commit/${{ github.sha }}|${{ github.sha }}@${{ github.ref }}>",
"short": true
}
],
"footer": "<https://github.com/${{ github.repository }}|${{ github.repository }}>",
}
]
}In payload you have to provide your own rich message layout which will be sent as is to Slack.
If you prefer to update a single message instead of posting multiple messages, you can pass a message_id to future steps.
Note: You must assign a step id to the first Slack notification step in order to reference it for future steps:
- name: Notify Slack about deployment start
if: success()
id: slack # IMPORTANT: Reference this step ID value in future Slack steps.
uses: wearerequired/slack-messaging-action@v2
with:
bot_token: ${{ secrets.SLACK_BOT_TOKEN }}
channel: deployments
payload: >-
{
"icon_emoji": ":rocket:",
"username": "Deployer",
"text": "Deployment started."
}
- name: Deployment
- name: Notify Slack about deployment success
if: success() # You can use the conditional checks to determine which notification to send.
uses: wearerequired/slack-messaging-action@v2
with:
bot_token: ${{ secrets.SLACK_BOT_TOKEN }}
message_id: ${{ steps.slack.outputs.message_id }} # Updates existing message from the first step.
channel: deployments
payload: >-
{
"icon_emoji": ":rocket:",
"username": "Deployer",
"text": "Deployment finished."
}
- name: Notify Slack about deployment fail
if: failure() # You can use the conditional checks to determine which notification to send.
uses: wearerequired/slack-messaging-action@v2
with:
bot_token: ${{ secrets.SLACK_BOT_TOKEN }}
message_id: ${{ steps.slack.outputs.message_id }} # Updates existing message from the first step.
channel: deployments
payload: >-
{
"icon_emoji": ":boom:",
"username": "Deployer",
"text": "Deployment failed."
}A bot token associated with a Slack app. Required
Note: The following bot token scopes are required: chat:write, chat:write.customize, chat:write.public, channels:read, and groups:read.
The name of the channel to post the message to. Required if no channel_id is provided.
Note: If your workspace has many channels, supplying only a channel may cause rate limiting issues with this GitHub Action. Consider supplying a channel_id instead.
The ID of the channel to post the message to. Required if no channel is provided, or if you need to send to a DM.
The JSON payload of a message to send. Required
Note: channel and ts are set to the values of the respective inputs.
The ID of a previous Slack message to update instead of posting a new message. Typically passed using the steps context:
message_id: ${{ steps.<your_first_slack_step_id>.outputs.message_id }}Returns the unique message ID, which is a timestamp which can be passed to future Slack API calls as ts.
The scripts and documentation in this project are released under the MIT license.
Slack Messaging is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(2)Slack Messaging is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.