Git Action to send messages to Slack. This action can be used to send message about the status of a Git Action workflow.
This action can be used after any other action. Below is simple example on using it:
1. Create a .github/workflows/slack-notification.yml
2. Add the following properties to slack-notification.yml file
on: push
name: Slack Notification Demo
jobs:
slackNotification:
name: Slack Notification Demo
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Slack Notification Demo
uses: bryannice/[email protected]
env:
SLACK_INCOMING_WEBHOOK: ${{ secrets.SLACK_INCOMING_WEBHOOK }}
SLACK_MESSAGE: 'Demo''ing the Slack Notification'
SLACK_TITLE: 'Slack Notification Demo'Go here for a template yml with all environment variables.
3. Generate Slack WebHook here
4. Encrypt Slack Webhook as a secret in the repo using this app.
These are the environment variables that can be set to pass in additional information about the Git Action.
| Variable Name | Required | Description |
|---|---|---|
| GITHUB_ACTOR | No | GitHub Actor variable passed from Git Actions. |
| GITHUB_ACTION | No | GitHub Action name variable passed from Git Actions. |
| GITHUB_EVENT_NAME | No | GitHub Action event name variable passed from Git Actions. |
| GITHUB_REF | No | GitHub reference variable passed from Git Actions. |
| GITHUB_REPOSITORY | No | GitHub Repository variable passed from Git Actions. |
| GITHUB_WORKFLOW | No | GitHub Action workflow varaible passed from Git Actions. |
| SLACK_CHANNEL | No | The Slack channel to use instead of the default. |
| SLACK_COLOR | No | Format color to use for the Slack message. |
| SLACK_ICON | No | The Slack user icon to use instead of the default. |
| SLACK_INCOMING_WEBHOOK | Yes | The Webhook URL generated by Slack to send messages too. |
| SLACK_MESSAGE | Yes | The message payload to be sent to Slack. |
| SLACK_USERNAME | No | The Slack username to use instead of the default. |
| SLACK_TITLE | Yes | Title of the Slack message being sent. |
- Using environment variables lists the default environment variables set in Git Actions.