Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ken-matsui/notify-slack
Send only task-related notifications from GitHub to Slack
https://github.com/ken-matsui/notify-slack
github github-actions slack
Last synced: 3 months ago
JSON representation
Send only task-related notifications from GitHub to Slack
- Host: GitHub
- URL: https://github.com/ken-matsui/notify-slack
- Owner: ken-matsui
- License: mit
- Created: 2021-11-15T21:26:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-02T01:04:08.000Z (3 months ago)
- Last Synced: 2024-10-04T12:32:28.093Z (3 months ago)
- Topics: github, github-actions, slack
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/notify-works-on-github-to-slack
- Size: 2.85 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# notify-slack
Send only task-related notifications from GitHub to Slack
## Message Examples on Slack
Users only specified in `userlist.toml` will be notified through Slack.
### All types of users
* Received a mention on a PR or an issue
* :speech_balloon: ken-matsui-developer mentioned you on **ken-matsui/notify-slack #1**
> 
**ken-matsui-developer**
> [**Comment on #1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1#issue-1054118774)
> @ken-matsui-reviewer
> Hi, I am testing notifications using ken-matsui/notify-slack.
> Please let me know if you receive any notification on Slack.
> 
[ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th
### Reviewers
* Received a review request
* :white_check_mark: ken-matsui-developer requested your review on **ken-matsui/notify-slack #1**
> **ken-matsui-developer**
> [**#1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1)
> [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th
### Developers
* Requested a review
* :white_check_mark: You requested ken-matsui-reviewer's review on **ken-matsui/notify-slack #1**
Please mark the related ticket(s) as **REVIEW**
> **ken-matsui-developer**
> [**#1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1)
> [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th
* Received a review on a developer's PR as:
* approved
* :tada: ken-matsui-reviewer approved your pull request on **ken-matsui/notify-slack #1**
> **ken-matsui-developer**
> [**Approval on #1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1)
> Looks good. Thanks!
> [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th
* requested changes
* :bulb: ken-matsui-reviewer requested changes on your pull request on **ken-matsui/notify-slack #1**
Please mark the related ticket(s) as **IN PROGRESS**
> **ken-matsui-developer**
> [**Requested Changes on #1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1)
> I would prefer the first line to be like the following.
> [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th
* commented
* :speech_balloon: ken-matsui-reviewer commented on your pull request on **ken-matsui/notify-slack #1**
> **ken-matsui-developer**
> [**Comment on #1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1)
> Is this a typo?
> [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th
* A developer's PR has been merged
* :white_check_mark: ken-matsui-reviewer merged your pull request on **ken-matsui/notify-slack #1**
Please mark the related ticket(s) as **DONE**
> **ken-matsui-developer**
> [**#1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1)
> [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th
## Usage
You will need to prepare two files on your repository which you want to configure.
### 1. Workflow file
`.github/workflows/notify-slack.yml`
```yaml
name: GitHub Notification
on:
pull_request:
types: [review_requested, closed]
pull_request_review:
types: [submitted]
issue_comment:
pull_request_review_comment:
jobs:
notify:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: ken-matsui/[email protected]
with:
slack_oauth_access_token: ${{ secrets.SLACK_OAUTH_ACCESS_TOKEN }}
```
### 2. User list file
`.github/userlist.toml`
```toml
[[users]]
github = "ken-matsui"
slack = "UXXXXXXXXXX"
[[users]]
github = "ken-matsui-2"
slack = "UXXXXXXXXXX"
```
## Frequently Asked Questions
### How to obtain an OAuth token of a Slack App?
1. Go to [Your Apps](https://api.slack.com/apps) on slack.com
2. Click `Create New App`, and select `From scratch`
4. Input `App Name` (e.g. `GitHub Notification`), and select your workspace
5. Click `Create App`
6. Expand `Add features and functionality` in `Building Apps for Slack`, and click `Permissions`
7. Go to the `Scopes` section, and click `Add an OAuth Scope` in `Bot Token Scopes`
8. Select `chat:write`
9. Go on the top of the current page, and click `Install to Workspace` on the `OAuth Tokens for Your Workspace` section
10. Click `Allow`
12. Copy an OAuth access token shown as `Bot User OAuth Token`
### How to find a Slack user ID?
See https://www.workast.com/help/articles/61000165203/.
### Are there any inputs and outputs?
This action has only a `slack_oauth_access_token` input and no outputs.
## Contributing
> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
Install the dependencies
```bash
$ npm install
```
Build the typescript and package it for distribution
```bash
$ npm run build && npm run package
```
### Publish to a distribution branch
Actions are run from GitHub repos so we will checkin the packed dist folder.
Then run [ncc](https://github.com/zeit/ncc) and push the results:
```bash
$ npm run package
$ git add dist
$ git commit -m "prod dependencies"
$ git tag v1.0.0
$ git push origin v1.0.0
```
Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
Your action is now published! :rocket:
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)