https://github.com/tryfabric/notify-slack-on-release

A GitHub Action that will notify a Slack channel when a new release is published
https://github.com/tryfabric/notify-slack-on-release

releases slack

Last synced: about 3 hours ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/tryfabric/notify-slack-on-release
• Owner: tryfabric
• License: mit
• Created: 2022-04-06T16:50:11.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-26T16:32:28.000Z (9 months ago)
• Last Synced: 2024-11-14T00:04:24.509Z (3 days ago)
• Topics: releases, slack
• Language: TypeScript
• Homepage: https://tryfabric.com
• Size: 1.04 MB
• Stars: 4
• Watchers: 1
• Forks: 3
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# 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](https://github.com/instantish/mack) to render the body of the release as Slack blocks.



# Usage

## Instructions

- [Create a Slack app](https://api.slack.com/apps/new) 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

```yaml

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: tryfabric/[email protected]

        with:

          slack_webhook_url: ${{ secrets.SLACK_WEBHOOK_URL }}

```



## Walkthrough video

[![Walkthrough](https://fabric-slack.s3.us-east-2.amazonaws.com/TJ5G67VHU/31fae90afecb2cf0022459532438b759-screen_shot_2022-04-08_at_12.21.08_pm.png)](https://www.youtube.com/watch?v=RKfsnp_AN-4&t=12s)

# Contributing

## Developing locally

Install the dependencies

```bash

$ npm install

```

Build the typescript and package it for distribution

```bash

$ npm run build && npm run package

```

Run the tests :heavy_check_mark:

```bash

$ npm test

...

```

## Releasing

Cut a new release

```bash

$ release-it

```