github-action-slack

A GitHub Action for sending Slack notifications

Sends messages that look like:

Setup

Your Slack workplace will need a (:cancel:) emoji. We've provided one in this repo.

Then, all you'll need is a webhook URL and a channel that you want to post to.

Usage

This is for workflows that run on push or pull_request

on: push
# ...
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      # ...
      - name: Slack
        uses: byu-oit/github-action-slack@v1
        if: always()
        with:
          status: ${{ job.status }}
          # You need the quotes (''), otherwise it gets interpreted as a comment
          channel: '#slack-bot-testing'
          webhook-url: ${{ secrets.slack_webhook_url }}

Contributing

Hopefully this is useful to others at BYU. Feel free to ask me some questions about it, but I make no promises about being able to commit time to support it.

Modifying Source Code

Just run npm install locally. There aren't many files here, so hopefully it should be pretty straightforward.

Cutting new releases

GitHub Actions will run the entry point from the action.yml. In our case, that happens to be /dist/index.js.

Actions run from GitHub repos. We don't want to check in node_modules. Hence, we package the app using npm run package.

Then, be sure to create a new GitHub release, following SemVer.