{"id":17317793,"url":"https://github.com/ken-matsui/notify-slack","last_synced_at":"2025-04-14T15:22:23.045Z","repository":{"id":36952077,"uuid":"428426432","full_name":"ken-matsui/notify-slack","owner":"ken-matsui","description":"Send only task-related notifications from GitHub to Slack","archived":false,"fork":false,"pushed_at":"2025-04-02T04:53:16.000Z","size":2909,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-14T15:22:12.838Z","etag":null,"topics":["github","github-actions","slack"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/notify-works-on-github-to-slack","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ken-matsui.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-15T21:26:14.000Z","updated_at":"2025-04-02T04:53:20.000Z","dependencies_parsed_at":"2023-02-17T12:16:06.331Z","dependency_job_id":"af04ae32-88fa-49bb-8279-e678feff441b","html_url":"https://github.com/ken-matsui/notify-slack","commit_stats":{"total_commits":269,"total_committers":2,"mean_commits":134.5,"dds":0.241635687732342,"last_synced_commit":"b367c9f62d1bfe8cabd0516f35d0dfa42ac86354"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ken-matsui%2Fnotify-slack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ken-matsui%2Fnotify-slack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ken-matsui%2Fnotify-slack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ken-matsui%2Fnotify-slack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ken-matsui","download_url":"https://codeload.github.com/ken-matsui/notify-slack/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248904671,"owners_count":21180840,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github","github-actions","slack"],"created_at":"2024-10-15T13:17:49.174Z","updated_at":"2025-04-14T15:22:23.022Z","avatar_url":"https://github.com/ken-matsui.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# notify-slack\n\nSend only task-related notifications from GitHub to Slack\n\n## Message Examples on Slack\n\nUsers only specified in `userlist.toml` will be notified through Slack.\n\n### All types of users\n* Received a mention on a PR or an issue\n  * :speech_balloon: ken-matsui-developer mentioned you on **ken-matsui/notify-slack #1**\u003cbr/\u003e\n    \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F26405363%3Fv%3D4\" width=\"15\" height=\"15\" /\u003e **ken-matsui-developer**\u003cbr/\u003e\n    \u003e [**Comment on #1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1#issue-1054118774)\u003cbr/\u003e\n    \u003e @ken-matsui-reviewer\u003cbr/\u003e\n    \u003e Hi, I am testing notifications using ken-matsui/notify-slack.\u003cbr/\u003e\n    \u003e Please let me know if you receive any notification on Slack.\u003cbr/\u003e\n    \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Fslack.github.com%2Fstatic%2Fimg%2Ffavicon-neutral.png\" width=\"15\" height=\"15\" /\u003e [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th\n\n### Reviewers\n* Received a review request\n  * :white_check_mark: ken-matsui-developer requested your review on **ken-matsui/notify-slack #1**\n    \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F26405363%3Fv%3D4\" width=\"15\" height=\"15\" /\u003e **ken-matsui-developer**\u003cbr/\u003e\n    \u003e [**#1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1)\u003cbr/\u003e\n    \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Fslack.github.com%2Fstatic%2Fimg%2Ffavicon-neutral.png\" width=\"15\" height=\"15\" /\u003e [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th\n\n### Developers\n* Requested a review\n  * :white_check_mark: You requested ken-matsui-reviewer's review on **ken-matsui/notify-slack #1**\u003cbr/\u003e\n    Please mark the related ticket(s) as **REVIEW**\n    \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F26405363%3Fv%3D4\" width=\"15\" height=\"15\" /\u003e **ken-matsui-developer**\u003cbr/\u003e\n    \u003e [**#1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1)\u003cbr/\u003e\n    \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Fslack.github.com%2Fstatic%2Fimg%2Ffavicon-neutral.png\" width=\"15\" height=\"15\" /\u003e [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th\n* Received a review on a developer's PR as:\n  * approved\n    * :tada: ken-matsui-reviewer approved your pull request on **ken-matsui/notify-slack #1**\n      \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F26405363%3Fv%3D4\" width=\"15\" height=\"15\" /\u003e **ken-matsui-developer**\u003cbr/\u003e\n      \u003e [**Approval on #1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1)\u003cbr/\u003e\n      \u003e Looks good. Thanks!\u003cbr/\u003e\n      \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Fslack.github.com%2Fstatic%2Fimg%2Ffavicon-neutral.png\" width=\"15\" height=\"15\" /\u003e [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th\n  * requested changes\n    * :bulb: ken-matsui-reviewer requested changes on your pull request on **ken-matsui/notify-slack #1**\u003cbr/\u003e\n      Please mark the related ticket(s) as **IN PROGRESS**\n      \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F26405363%3Fv%3D4\" width=\"15\" height=\"15\" /\u003e **ken-matsui-developer**\u003cbr/\u003e\n      \u003e [**Requested Changes on #1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1)\u003cbr/\u003e\n      \u003e I would prefer the first line to be like the following.\u003cbr/\u003e\n      \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Fslack.github.com%2Fstatic%2Fimg%2Ffavicon-neutral.png\" width=\"15\" height=\"15\" /\u003e [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th\n  * commented\n    * :speech_balloon: ken-matsui-reviewer commented on your pull request on **ken-matsui/notify-slack #1**\u003cbr/\u003e\n      \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F26405363%3Fv%3D4\" width=\"15\" height=\"15\" /\u003e **ken-matsui-developer**\u003cbr/\u003e\n      \u003e [**Comment on #1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1)\u003cbr/\u003e\n      \u003e Is this a typo?\u003cbr/\u003e\n      \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Fslack.github.com%2Fstatic%2Fimg%2Ffavicon-neutral.png\" width=\"15\" height=\"15\" /\u003e [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th\n* A developer's PR has been merged\n  * :white_check_mark: ken-matsui-reviewer merged your pull request on **ken-matsui/notify-slack #1**\u003cbr/\u003e\n    Please mark the related ticket(s) as **DONE**\u003cbr/\u003e\n    \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F26405363%3Fv%3D4\" width=\"15\" height=\"15\" /\u003e **ken-matsui-developer**\u003cbr/\u003e\n    \u003e [**#1 Testing Notifications**](https://github.com/ken-matsui/notify-slack/pull/1)\u003cbr/\u003e\n    \u003e \u003cimg src=\"https://slack-imgs.com/?c=1\u0026o1=wi32.he32.si\u0026url=https%3A%2F%2Fslack.github.com%2Fstatic%2Fimg%2Ffavicon-neutral.png\" width=\"15\" height=\"15\" /\u003e [ken-matsui/notify-slack](https://github.com/ken-matsui/notify-slack) | Jan 6th\n\n## Usage\n\nYou will need to prepare two files on your repository which you want to configure.\n\n### 1. Workflow file\n\n`.github/workflows/notify-slack.yml`\n\n```yaml\nname: GitHub Notification\n\non:\n  pull_request:\n    types: [review_requested, closed]\n  pull_request_review:\n    types: [submitted]\n  issue_comment:\n  pull_request_review_comment:\n\njobs:\n  notify:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v2\n\n      - uses: ken-matsui/notify-slack@v1.0.4\n        with:\n          slack_oauth_access_token: ${{ secrets.SLACK_OAUTH_ACCESS_TOKEN }}\n```\n\n### 2. User list file\n\n`.github/userlist.toml`\n\n```toml\n[[users]]\ngithub = \"ken-matsui\"\nslack = \"UXXXXXXXXXX\"\n\n[[users]]\ngithub = \"ken-matsui-2\"\nslack = \"UXXXXXXXXXX\"\n```\n\n## Frequently Asked Questions\n\n### How to obtain an OAuth token of a Slack App?\n\n1. Go to [Your Apps](https://api.slack.com/apps) on slack.com\n2. Click `Create New App`, and select `From scratch`\n4. Input `App Name` (e.g. `GitHub Notification`), and select your workspace\n5. Click `Create App`\n6. Expand `Add features and functionality` in `Building Apps for Slack`, and click `Permissions`\n7. Go to the `Scopes` section, and click `Add an OAuth Scope` in `Bot Token Scopes`\n8. Select `chat:write`\n9. Go on the top of the current page, and click `Install to Workspace` on the `OAuth Tokens for Your Workspace` section\n10. Click `Allow`\n12. Copy an OAuth access token shown as `Bot User OAuth Token`\n\n### How to find a Slack user ID?\n\nSee https://www.workast.com/help/articles/61000165203/.\n\n### Are there any inputs and outputs?\n\nThis action has only a `slack_oauth_access_token` input and no outputs.\n\n## Contributing\n\n\u003e First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.\n\nInstall the dependencies\n```bash\n$ npm install\n```\n\nBuild the typescript and package it for distribution\n```bash\n$ npm run build \u0026\u0026 npm run package\n```\n\n\u003c!--\nRun the tests :heavy_check_mark:\n```bash\n$ npm test\n\n PASS  ./index.test.js\n  ✓ throws invalid number (3ms)\n  ✓ wait 500 ms (504ms)\n  ✓ test runs (95ms)\n\n...\n```\n--\u003e\n\n### Publish to a distribution branch\n\nActions are run from GitHub repos so we will checkin the packed dist folder.\n\nThen run [ncc](https://github.com/zeit/ncc) and push the results:\n```bash\n$ npm run package\n$ git add dist\n$ git commit -m \"prod dependencies\"\n$ git tag v1.0.0\n$ git push origin v1.0.0\n```\n\nNote: 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.\n\nYour action is now published! :rocket:\n\nSee the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fken-matsui%2Fnotify-slack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fken-matsui%2Fnotify-slack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fken-matsui%2Fnotify-slack/lists"}