— With support for Slack's optional arguments
This Action allows you to send messages to Slack from your Github Actions. Supports Slack's required arguments as well as all the optional once. It's JavaScript-based and thus fast to run.
This action is just an HTTPS call to Slack API, so you can easily build this by yourself, or use this action or any one of the hundred other Slack actions available.
- Slack Workspace and Channel
- A Slack App and Bot - the App and Bot will be used to send messages to your channel. It sounds hard, but it's not :)
- A Github Action - the place where you wants to send Slack messages
- Github Secret - the Slack Bot auth token, used when posting messages to Slack API
Required: Github Repository Secret:
SLACK_BOT_USER_OAUTH_ACCESS_TOKEN- This is the Slack App token, the credentials for allowing you to send messages from github to Slack
Required: Github Action Parameters:
-
slack-bot-user-oauth-access-token-SLACK_BOT_USER_OAUTH_ACCESS_TOKENsecret -
slack-channel- The channel where you want the message -
slack-text- The text of the message
Optional: Github Action Parameters:
All the optional parameters that Slack supports, can be sent via the slack-optional-xxx parameter.
| Slack parameter name | Yaml parameter name |
|---|---|
icon_emoji |
slack-optional-icon_emoji |
link_names |
slack-optional-link_names |
and so forth.
Please see Slack API documentation for all available optional parameters: https://api.slack.com/methods/chat.postMessage
.github/workflows/slack-notification.yml
This will send a Slack message every time someone push, creates pull request or create an issue
name: slack-notification
on: [push, pull_request, issues]
jobs:
slack-notifications:
runs-on: ubuntu-latest
name: Sends a message to Slack when a push, a pull request or an issue is made
steps:
- name: Send message to Slack API
uses: archive/github-actions-slack@v1.0.3
with:
slack-bot-user-oauth-access-token: ${{ secrets.SLACK_BOT_USER_OAUTH_ACCESS_TOKEN }}
slack-channel: test
slack-text: Hello! Event "${{ github.event_name }}" in "${{ github.repository }}" 🤓
- name: Result from "Send Message"
run: echo "The result was ${{ steps.notify.outputs.slack-result }}"
.github/workflows/slack-notification.yml
name: slack-notification-with-optional-parameters
on: [push, pull_request, issues]
jobs:
slack-notification-with-optional-parameters:
runs-on: ubuntu-latest
name: Sends a message to Slack when a push, a pull request or an issue is made
steps:
- name: Send message to Slack API
uses: archive/github-actions-slack@v1.0.3
with:
slack-bot-user-oauth-access-token: ${{ secrets.SLACK_BOT_USER_OAUTH_ACCESS_TOKEN }}
slack-channel: test
slack-text: Hello! Something is burning! Or not...
slack-optional-icon_emoji: ":fire:"
slack-optional-as_user: false
- name: Result from "Send Message"
run: echo "The result was ${{ steps.notify.outputs.slack-result }}"
Follow this guide on how to create a Slack App and Bot for your workspace:
You should:
- Create a new Slack App, https://api.slack.com/apps?new_app=1
- Go to "Basic Information" > "Display Information" > "App icon & Preview" and add avatar for you App. This will be shown in Slack when you receive messages
- Go to "Bot User" > "Add" and add a bot user to your Slack App
- Go to "Install App" > "Install App to Workspace" to install your Slack App into your Slack workspace
- Done
To be able to send messages to slack, the Action needs the Auth Token for the Slack App. Since the Auth Token is sensitive information, you should NOT place it in the yaml file of the Action, but instead in the Github Secrets area.
- Go to your App on Slack, https://api.slack.com/apps/
- Go to "OAuth & Permissions" > "Bot User OAuth Access Token"
- Copy the
Bot User OAuth Access Token - Go to your Github Repo
- Go to "Settings" > "Secrets" for the repo
- Create a new secret called
SLACK_BOT_USER_OAUTH_ACCESS_TOKENwith the value fromBot User OAuth Access Token - Done
- Go to your github repo
- Go to actions
- Create a new one, you can use the samples above
Please look at the individual steps on your Github Action. Maybe you have forgotten to set Channel or Token:
You can easily print everything you have while running the action. It can be a good way to see what you can send to Slack.
on: push
jobs:
one:
runs-on: ubuntu-16.04
steps:
- name: Dump GitHub context
env:
GITHUB_CONTEXT: ${{ toJson(github) }}
run: echo "$GITHUB_CONTEXT"
- name: Dump job context
env:
JOB_CONTEXT: ${{ toJson(job) }}
run: echo "$JOB_CONTEXT"
- name: Dump steps context
env:
STEPS_CONTEXT: ${{ toJson(steps) }}
run: echo "$STEPS_CONTEXT"
- name: Dump runner context
env:
RUNNER_CONTEXT: ${{ toJson(runner) }}
run: echo "$RUNNER_CONTEXT"
- name: Dump strategy context
env:
STRATEGY_CONTEXT: ${{ toJson(strategy) }}
run: echo "$STRATEGY_CONTEXT"
- name: Dump matrix context
env:
MATRIX_CONTEXT: ${{ toJson(matrix) }}
run: echo "$MATRIX_CONTEXT"
"JavaScript actions can run directly on any of the GitHub-hosted virtual machines, and separate the action code from the environment used to run the code. Using a JavaScript action simplifies the action code and executes faster than a Docker container action." (https://help.github.com/en/github/automating-your-workflow-with-github-actions/about-actions)
It's simple, it just takes all the parameters and does an HTTPS POST to api.slack.com.
By default the avatar in Slack will be the same as for the Slack App you created. If you want to change this based on action, look at the https://api.slack.com/methods/chat.postMessage icon_emoji parameter.
It was a good way to learn more about Github Actions
This action is just an HTTPS POST to Slack API, so you can easily build this by yourself, or use this, or use any other action available on the marketplace :)
See package.json for yarn lint, yarn test, etc.
Remember to create the dist with yarn build.
To run local integration test (from this repository):
env BOT_USER_OAUTH_ACCESS_TOKEN=<YOUR TOKEN> CHANNEL=<YOUR CHANNEL> TEXT="Test" node integration-test/end-to-end.js
To debug action and see what payload is being sent to slack, enable debugging: https://docs.github.com/en/actions/configuring-and-managing-workflows/managing-a-workflow-run#enabling-debug-logging