Rules

Hush's defaults decide what needs you. Rules change that for the threads that you choose: a repository that is only FYI for you, a bot to mute, a person whose replies you always want pushed.

How rules work

• Hush sorts a thread with its defaults first. Then it checks your rules from top to bottom. The first rule that matches wins; the rules below it do not count for that thread.
• A rule has conditions (when) and effects (then). All conditions must match. A condition with more than one value matches any of them.
• When you save rules, Hush sorts your stored threads again, so the lists change at once.

A rule can do one or more of these:

Move it acts when the thread has new activity or when the rule starts to match. If you bring a thread back to the inbox yourself, it stays there until its next activity.

Make a rule

In Settings → Inbox → Rules:

• New rule adds an empty rule. From a template adds a finished example.
• Or right-click a thread in the inbox and choose Make a rule…: the new rule has that thread's repository and type.

Each rule is a card. Give it a name (it shows on the threads it sorts, as “rule: Docs repo is FYI”), add conditions, and choose what it does. You can write the conditions as a query, such as repo:acme/website type:pr, or pick them one by one. Turn a rule off with its switch; move, duplicate, or delete it from its buttons.

While you edit, each card shows how many of your stored threads it would catch, and the footer says what would change if you save: “If you save: 4 to FYI, 2 to Muted.” Nothing changes until you choose Save rules.

Conditions

Every value is in the query language reference. The complete list of JSON conditions:

Examples

Most rules are one line. As queries, with what they do:

The same rules in settings.json:

{
	"rules": [
		{ "name": "Website is FYI", "when": { "repo": "acme/website" }, "then": { "category": "fyi" } },
		{
			"name": "Mute dependabot",
			"when": { "author": "dependabot*" },
			"then": { "category": "muted" }
		},
		{
			"name": "Quiet reviews on drafts",
			"when": { "kind": ["review"], "draft": true },
			"then": { "push": false }
		},
		{
			"name": "Svelte releases need me",
			"when": { "type": ["Release"], "repo": "sveltejs/*" },
			"then": { "category": "action", "push": true }
		},
		{
			"name": "Bot comments are done",
			"when": { "by": "github-actions", "category": ["fyi"] },
			"then": { "triage": "done" }
		},
		{
			"name": "Nightly CI can wait",
			"when": { "type": ["CheckSuite"], "repo": "acme/nightly" },
			"then": { "triage": "snooze", "snoozeHours": 12, "push": false }
		}
	]
}

Tips

• Put narrow rules above wide ones. A wide rule at the top (such as repo:acme/*) catches everything below it.
• Use in: and needs: to change only part of Hush's sorting: repo:acme/big-monorepo in:fyi changes nothing about what needs you there.
• To hear about something without seeing it in Needs you, use "push": true with "category": "fyi".
• A rule never sends a thread to GitHub: Muted by a rule stays in Hush. Mute in the inbox unsubscribes you on GitHub too.