Skip to content

Commit

Permalink
config_docs.md: clarify why GH handle matching is needed
Browse files Browse the repository at this point in the history
  • Loading branch information
phongulus committed Oct 7, 2024
1 parent 7756b52 commit 2ec8409
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion documentation/config_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ Refer [here](https://docs.github.com/en/free-pro-team@latest/developers/webhooks
| `ignored_users` | list of users to be ignored on all notifications | no user is ignored |
| `user_mappings` | list of mappings from git email and/or GitHub handle to Slack email | no mapping defined

Note that in `user_mappings`, git email to Slack email mappings are used for status DMs, while GitHub handle to Slack email mappings are used to get Slack mentions in notifications.
Note that in `user_mappings`, git email to Slack email mappings are used for status DMs, while GitHub handle to Slack email mappings are used to get Slack mentions in comment notifications.

The reason for these two separate Slack email matching schemes is that in the case of commits, the git email is available in the GitHub payload and can be used to directly match with Slack emails for status DMs (`user_mappings` can be used to manually override if there is a known mismatch between git email and Slack email). However, for actions done on GitHub itself (e.g. opening PRs, commenting, etc.), usually the only thing available is the GitHub username. To get the email in these cases, a user will have to go to settings and set their email to public, which is (1) hard to enforce if there are many working on the monorepo, and (2) might be undesirable for privacy reasons.

## Label Options

Expand Down

0 comments on commit 2ec8409

Please sign in to comment.