arrdem/source
1
0
Fork 0
Code Issues 11 Pull requests Projects Releases Packages Wiki Activity

Tighten readme; license

Browse source
This commit is contained in:
Reid 'arrdem' McKenzie 2023-07-27 17:33:08 -06:00
parent ada34c8ac9
commit 15816ef524
1 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
projects/gh-unnotifier/README.md
View file

@ -6,8 +6,11 @@ However, since we are a team, many of these notificaitons don't require that I a
I would like to not be notified at all, but Github's notification filtering features are non-existent so I'm doing this the hard way.
This script at present does the simple thing - it looks through notifications for activity on resolved PRs and marks such activity as read automatically.
Unfortunately, that's the best you can really do.
This script at present does the simple thing - it looks through notifications for activity and tries to identify trivially ignorable notifications which:
1. Relate 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) 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.
## Usage
You're gonna need a `config.toml` like
@ -23,10 +26,8 @@ org_shitlist = [
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:
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) AND is in an org in the `org_shitlist`
## License
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.
Copyright © Reid D. McKenzie 2023, published under the terms of the Anti-Capitalist Software License v1.4 and later.
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.
https://anticapitalist.software/