ddzz / slack-github-action

Slack Send GitHub Action

Send data into Slack using this GitHub Action! This package has three different techniques to send data to Slack:

1. Send data to Slack's Workflow Builder (requires a paid Slack instance).
2. Send data via a Slack app to post to a specific channel (use an existing custom app or create a new one).
3. Send data via an Slack's Incoming Webhook URL (use an existing custom app or create a new one)

The recommended way to use this action is with Slack's Workflow Builder (if you're on a paid Slack plan).

Slack Workflow Builder Route

Sending data to Slack's Workflow builder is the recommended way to use this action. This action will send data into Slack via a webhook URL. Follow these steps to create a Slack workflow using webhooks. The Slack workflow webhook url will be in the form of https://hooks.slack.com/workflows/..... The payload sent by this GitHub action will be flattened (all nested keys moved top level) and stringified since Slack's workflow builder only supports top level string values in payloads.

You need to define expected variables in the payload the webhook will receive. If these variables are missing in the payload, an error is returned.

Setup

• Create a Slack workflow webhook
• Copy the webhook URL (https://hooks.slack.com/workflows/....) and add it as a secret in your repo settings named SLACK_WEBHOOK_URL.
• Add a step to your GitHub action to send data to your Webhook
• Configure your Slack workflow to use variables from the incoming payload from the GitHub Action. You can select where you want to post the data and how you want to format it in Slack's worflow builder interface.

Usage

- name: Send GitHub Action trigger data to Slack workflow
  id: slack
  uses: slackapi/slack-github-action@v1.16.0
  env:
    SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

or

- name: Send custom JSON data to Slack workflow
  id: slack
  uses: slackapi/slack-github-action@v1.16.0
  with:
    payload: "{\"key\":\"value\",\"foo\":\"bar\"}" # This data can be any valid JSON from a previous step in the GitHub Action
  env:
    SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

Slack App Route

This route allows your GitHub Actions job to post a message in a Slack channel or direct message by utilizing chat.postMessage API method. With this route, you can instantly post a message without setting up workflows.

Setup

• Create a Slack App for your workspace (alternatively use an existing app you have already created and installed)
• Add the chat.write bot scope under OAuth & Permissions
• Install the app to your workspace
• Invite the bot user into the channel (/invite @bot_user_name)

Usage

- name: Post to a Slack channel
  id: slack
  uses: slackapi/slack-github-action@v1.16.0
  with:
    channel-id: 'CHANNEL_ID'  # Slack channel id or name to post message. https://api.slack.com/methods/chat.postMessage#channels
    slack-message: 'posting from a github action!'
  env:
    SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}

Slack Incoming Webhook Route

This route allows your GitHub Actions job to post a message in a Slack channel or direct message by utilizing Incoming Webhooks. With this route, you can instantly post a message.

Incoming Webhooks conform to the same rules and functionality as any of our other messaging APIs. You can make your posted messages as simple as a single line of text, or make them really useful with interactive components. To make the message more expressive and useful use Block Kit to build and test visual components.

Setup

• Create a Slack App for your workspace (alternatively use an existing app you have already created and installed)
• Add the incoming-webhook bot scope under OAuth & Permissions
• Install the app to your workspace (you will select a channel to notify)

Usage

- name: Send custom JSON data to Slack workflow
  id: slack
  uses: slackapi/slack-github-action@v1.16.0
  with:
    payload: "{\"blocks\":[{\"type\":\"section\",\"text\":{\"type\":\"mrkdwn\",\"text\":\"You have a new request: \"}},{\"type\":\"section\",\"fields\":[{\"type\":\"mrkdwn\",\"text\":\"*Type:* Computer (laptop)\"},{\"type\":\"mrkdwn\",\"text\":\"*When:* Submitted Aut 10\"}]}]}"
  env:
    SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
    SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK

Contributing

See CONTRIBUTING.

License

See LICENSE.