Projects with a lot of issue volume accumulate a lot of open issues which are not immediately actionable, usually because they're waiting for a response from a contributor. There's no easy way to hide those from the Github interface or signal to other maintainers that an open issue or PR isn't actionable yet.
Enter github-snooze-button!
Add a "snooze" label to an issue, and github-snooze-button will remove the label whenever
github-snooze-button can operate in two modes: deployed to AWS Lambda, or polling a Amazon SQS queue locally.
github-snooze-button uses .ini-style configuration files that look like:
[default]
github_username = your_username
github_token = your_token
aws_key = your_key
aws_secret = your_secret
snooze_label = snooze
# aws_region = us-west-2 # optional
[your_username/repo1]
ignore_member_of = cool_organization # ignore comments from members of an organization
[your_username/repo2]
snooze_label = response required
The AWS credentials in the config file are sent to Github and used to push notifications into SNS. The listener also uses them to consume events from SQS. They are not used to configure the Lambda deployment.
public_repo
, admin:repo_hook
, and (if you're using ignore_member_of
, org:read
) scopes. (Note that public_repo
gives write permission! These credentials will be embedded in the Lambda deployment package, so you should consider the contents of the deployment package sensitive.)pip install git+https://github.com/tdsmith/github-snooze-button.git
snooze_deploy /path/to/config.ini
. snooze_deploy
will:
/tdsmith/github-snooze-button/snooze_lambda_role
IAM role with the AWSLambdaBasicExecutionRole
policyAnd now you're live.
public_repo
and admin:repo_hook
scopes.pip install git+https://github.com/tdsmith/github-snooze-button.git
snooze_listen /path/to/config.ini
Note that the queue will continue collecting events unless you disconnect the repository from SNS.
The fastest way to disable github-snooze-button is by deleting the Amazon SNS service from your repository's "Webhooks & services" configuration page. It will be automatically recreated the next time you run snooze in either mode.
Tim D. Smith: snooze at tds.xyz, Freenode: tdsmith, @biotimylated