cefeboru/action-webhook-slack-notify

GitHub Action for sending a notification to a Slack channel

Slack Notify - GitHub Action

A GitHub Action to send a message to a Slack channel.

Screenshot

Usage

You can use this action after any other action. Here is an example setup of this action:

1. Create a .github/workflows/slack-notify.yml file in your GitHub repo.
2. Add the following code to the slack-notify.yml file.

on: push
name: Slack Notification Demo
jobs:
  slackNotification:
    name: Slack Notification
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Slack Notification
      uses: partnerhero/action-webhook-slack-notify@v2.1.0
      env:
        SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

3. Create SLACK_WEBHOOK secret using GitHub Action's Secret. You can generate a Slack incoming webhook token from here.

Environment Variables

By default, action is designed to run with minimal configuration but you can alter Slack notification using following environment variables:

Variable	Default	Purpose
SLACK_CHANNEL	Set during Slack webhook creation	Specify Slack channel in which message needs to be sent
SLACK_USERNAME	DevOpsBot	The name of the sender of the message. Does not need to be a "real" username
SLACK_ICON_EMOJI	-	User/Bot icon shown with Slack message, in case you do not wish to add a URL for slack icon as above, you can set slack emoji in this env variable. Example value: :bell: or any other valid slack emoji.
SLACK_COLOR	good (green)	You can pass an RGB value like #efefef which would change color on left side vertical line of Slack message.
SLACK_MESSAGE	Generated from git commit message.	The main Slack message in attachment.
SLACK_TITLE	Message	Title to use before main Slack message.
SITE_NAME	-	Environment site name
SITE_URL	-	Site URL
SHOW_ACTIONS_URL	true	Show the actions url field
SHOW_REF	true	Show the ref field
SHOW_EVENT	true	Show the event that triggered the workflow

You can see the action block with all variables as below:

    - name: Slack Notification
      uses: partnerhero/action-webhook-slack-notify@v2.1.0
      env:
        SLACK_CHANNEL: general
        SLACK_COLOR: '#3278BD'
        SLACK_MESSAGE: 'Post Content :rocket:'
        SLACK_TITLE: Post Title
        SLACK_USERNAME: Devops Bot
        SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
        SITE_NAME: staging
        SITE_URL: http://myapp.staging.com
        SHOW_ACTIONS_URL: true
        SHOW_REF: true
        SHOW_EVENT: true

Hashicorp Vault (Optional)

This GitHub action supports Hashicorp Vault.

To enable Hashicorp Vault support, please define following GitHub secrets:

Variable	Purpose	Example Vaule
VAULT_ADDR	Vault server address	https://example.com:8200
VAULT_TOKEN	Vault token	s.gIX5MKov9TUp7iiIqhrP1HgN

You will need to change secrets line in slack-notify.yml file to look like below.

on: push
name: Slack Notification Demo
jobs:
  slackNotification:
    name: Slack Notification
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Slack Notification
      uses: partnerhero/action-webhook-slack-notify@v2.1.0
      env:
        VAULT_ADDR: ${{ secrets.VAULT_ADDR }}
        VAULT_TOKEN: ${{ secrets.VAULT_TOKEN }}

GitHub action uses VAULT_TOKEN to connect to VAULT_ADDR to retrieve slack webhook from Vault.

In the Vault, the Slack webhook should be setup as field webhook on path secret/slack.

License

MIT © 2019 rtCamp

This action was forked from https://github.com/rtCamp/action-slack-notify created by rtCamp.

Made with love and 🍵 @ PartnerHero