More notes

This commit is contained in:
Reid 'arrdem' McKenzie 2023-07-27 17:26:03 -06:00
parent 5895e7f404
commit ada34c8ac9

View file

@ -15,12 +15,18 @@ You're gonna need a `config.toml` like
``` toml ``` toml
[gh-unnotifier] [gh-unnotifier]
api_key = "your secret value" api_key = "your secret value"
org_shitlist = [
"your-employer-here",
"their-oss-group-here",
]
``` ```
And then you can `bazel run //projects/gh-unnotifier -- maintain --config $(realpath config.toml)`. And then you can `bazel run //projects/gh-unnotifier -- maintain --config $(realpath config.toml)`.
By default, `maintain` will go over your notifications once a minute and mark anything as read which: By default, `maintain` will go over your notifications once a minute and mark anything as read which:
1. Relates to a closed (merged or abandoned) PR 1. Relates to a closed (merged or abandoned) PR
2. Does not have an outstanding review request against EITHER the user OR one of the user's teams (someone else already reviewed it) 2. Does not have an outstanding review request against EITHER the user OR one of the user's teams (someone else already reviewed it) AND is in an org in the `org_shitlist`
Note that the `org_shitlist` serves as a gate to allow you to opt notifications from organizations into auto-dismissal, rather than auto-dismissing anything you aren't a reviewer on from anywhere as that covers many other potentially desirable notifications too.
It would be nice if there was a way to quickly ascertain what review permissions the configured user has and whether requested reviews to relevant groups have already been provided, but so far that's a pipe dream. It would be nice if there was a way to quickly ascertain what review permissions the configured user has and whether requested reviews to relevant groups have already been provided, but so far that's a pipe dream.