Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amendx/slackbot-release
A Github Action for Slack notifications when a new release is out :)
https://github.com/amendx/slackbot-release
action devops github-actions integration-slack release-automation release-notes slack slack-api step
Last synced: 15 days ago
JSON representation
A Github Action for Slack notifications when a new release is out :)
- Host: GitHub
- URL: https://github.com/amendx/slackbot-release
- Owner: amendx
- License: mit
- Created: 2022-07-25T16:00:50.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-23T15:28:24.000Z (over 1 year ago)
- Last Synced: 2025-01-08T22:03:08.493Z (16 days ago)
- Topics: action, devops, github-actions, integration-slack, release-automation, release-notes, slack, slack-api, step
- Language: TypeScript
- Homepage:
- Size: 565 KB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Notify Slack on changes
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/tryfabric/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: Slackbot on releaseon:
release:
types:
- createdjobs:
notify_slack:
runs-on: ubuntu-latest
name: Notify Slack on Release
steps:
- name: Notify Slack on Releases
uses: amendx/[email protected]
with:
slack_webhook_url: ${{ secrets.SLACK_WEBHOOK_URL }}
```## Developing locally
Install the dependencies```bash
$ npm install
```
Build the typescript and package it for distribution```bash
$ npm run build && npm run package
```## Releasing
Cut a new release
```bash
$ release-it
```