Prunes GitHub notifications you don't care about, such as automated dependency bumps. 🧹
prune-github-notifications can be run on the CLI with an auth token for notifications access:
npx prune-github-notifications| Option | Type | Default | Description |
|---|---|---|---|
--auth |
string |
process.env.GH_TOKEN or executing gh auth token |
Auth token for GitHub from octokit-from-auth. |
--bandwidth |
number |
6 |
Maximum parallel requests to start at once. |
--reason |
string[] |
["subscribed"] |
Notification reason(s) to filter to. |
--title |
string[] |
["^chore\(deps\): update .+ to", /^build\(deps-dev\): bump .+ to"] |
Notification title regular expressions to filter to. |
--watch |
number |
0 |
A seconds interval to continuously re-run this on, if truthy. |
For example, providing all functional options on the CLI:
npx prune-github-notifications --bandwidth 10 --reason subscribed --title "^chore.+ update .+ to"Running in watch mode to clear notifications every ten seconds:
npx prune-github-notifications --watch 10npm i prune-github-notificationsimport { pruneGitHubNotifications } from "prune-github-notifications";
await pruneGitHubNotifications({ auth: "gho_..." });If a process.env.GH_TOKEN is set, then the auth parameter will default to it:
await pruneGitHubNotifications();Only auth is required, and only if a GH_TOKEN isn't available.
| Option | Type | Default | Description |
|---|---|---|---|
auth |
string |
process.env.GH_TOKEN |
GitHub authentication token with notifications access. |
bandwidth |
number |
6 |
Maximum parallel requests to start at once. |
reason |
Set<string> |
Set {"subscribed"} |
Notification reason(s) to filter to. |
title |
RegExp[] |
[/^chore\(deps\): update .+ to/, /^build\(deps-dev\): bump .+ to/] |
Notification title regular expressions to filter to. |
For example, providing all options to the Node.js API:
await pruneGitHubNotifications({
auth: "gho_...",
bandwidth: 10,
reason: subscribed,
title: ["^chore.+ update .+ to"],
});See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md.
Thanks! 🧹
 Josh Goldberg 🔧 🚧 🤔 💻 🐛 🖋 📖 🚇 📆 |
💝 This package was templated with
create-typescript-appusing the Bingo framework.