From 81bd670e0007e3531dc185dd00b6d8dae0f19712 Mon Sep 17 00:00:00 2001 From: Reid 'arrdem' McKenzie Date: Thu, 27 Jul 2023 17:33:08 -0600 Subject: [PATCH] Tighten readme; license --- projects/gh-unnotifier/README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/projects/gh-unnotifier/README.md b/projects/gh-unnotifier/README.md index 409d688..a1d2b5d 100644 --- a/projects/gh-unnotifier/README.md +++ b/projects/gh-unnotifier/README.md @@ -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/