Skip to content

A GitHub Action that will notify a Slack channel when a new release is published

License

Notifications You must be signed in to change notification settings

alexander-kraev-snyk/notify-slack-on-release

 
 

Repository files navigation

Notify Slack on Release

This GitHub Action sends a rich-text notification to your Slack channel when there's a new release in your GitHub repository.

We use mack to render the body of the release as Slack blocks.

Screen Shot 2022-04-06 at 5 02 52 PM

Usage

Instructions

  • Create a Slack app called "Release Bot"
  • Click Incoming Webhooks and toggle Activate Incoming Webhooks
  • Click Add New Webhook to Workspace
  • Pick the channel the app will post to and then click Authorize
  • Set your SLACK_WEBHOOK_URL to the Webhook URL
  • Create a workflow file
name: Notify Slack on Release

on:
  release:
    types:
      - created

jobs:
  notify_slack:
    runs-on: ubuntu-latest
    name: Notify Slack on Release
    steps:
      - name: Notify Slack on Release
        uses: instantish/[email protected]
        with:
          slack_webhook_url: ${{ secrets.SLACK_WEBHOOK_URL }}

Screen Shot 2022-04-06 at 4 55 22 PM

Walkthrough video

Walkthrough

Contributing

Developing locally

Install the dependencies

$ npm install

Build the typescript and package it for distribution

$ npm run build && npm run package

Run the tests ✔️

$ npm test
...

Releasing

Cut a new release

$ release-it

About

A GitHub Action that will notify a Slack channel when a new release is published

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 97.0%
  • JavaScript 3.0%