|
| 1 | +# GitHub + Slack Integration |
| 2 | + |
| 3 | +## About |
| 4 | + |
| 5 | +The GitHub integration for Slack gives full visibility in GitHub projects right in Slack channels, where you can generate ideas, triage issues and collaborate with other teams to move projects forward. This integration is an open source project, built and maintained by GitHub. |
| 6 | + |
| 7 | +### Configuration |
| 8 | +You can customize your notifications by subscribing to activity that is relevant to your Slack channel, and unsubscribing from activity that is less helpful to your project. |
| 9 | + |
| 10 | +Settings are configured with the `/github` slash command: |
| 11 | + |
| 12 | +``` |
| 13 | +/github subscribe owner/repo [feature] |
| 14 | +/github unsubscribe owner/repo [feature] |
| 15 | +``` |
| 16 | + |
| 17 | +These are enabled by default, and can be disabled with the `/github unsubscribe owner/repo [feature]` command: |
| 18 | + |
| 19 | +- `issues` - Opened or closed issues |
| 20 | +- `pulls` - New or merged pull requests |
| 21 | +- `statuses` - Statuses on pull requests |
| 22 | +- `commits` - New commits on the default branch (usually `master`) |
| 23 | +- `deployments` - Updated status on deployments |
| 24 | +- `public` - A repository switching from private to public |
| 25 | +- `releases` - Published releases |
| 26 | + |
| 27 | +These are disabled by default, and can be enabled with the `/github subscribe owner/repo [feature]` command: |
| 28 | + |
| 29 | +- `reviews` - Pull request reviews |
| 30 | +- `comments` - New comments on issues and pull requests |
| 31 | +- `branches` - Created or deleted branches |
| 32 | +- `commits:all` - All commits pushed to any branch |
| 33 | + |
| 34 | +You can subscribe or unsubscribe from multiple settings at once. For example, to turn on activity for pull request reviews and comments: |
| 35 | + |
| 36 | +``` |
| 37 | +/github subscribe owner/repo reviews comments |
| 38 | +``` |
| 39 | + |
| 40 | +And to turn it back off: |
| 41 | + |
| 42 | +``` |
| 43 | +/github unsubscribe owner/repo reviews comments |
| 44 | +``` |
| 45 | + |
| 46 | +# Note For The Community |
| 47 | + |
| 48 | +There are times when this integration may cause `Revoke Access` error. |
| 49 | + |
| 50 | +In that case use following slash command in the github app |
| 51 | +``` |
| 52 | +/github signin |
| 53 | +``` |
| 54 | +This will provide the required authorization. |
| 55 | + |
| 56 | +:+1: Hope it helps |
0 commit comments