At my workplace, we use github pretty extensively, and with github, we use organization teams. They allow assigning permissions on different repos to groups of people, but, are a really great way of @-mentioning people. This is wonderful, but sadly, github doesn’t make it easy for gmail filters to tell the difference between an email notification that you got because it was interesting to you, or because somebody sent a heads-up @-mention to a team you’re on.
I thought that was impossible to solve, but I was so wrong!
The setup: github notification email basics
Github makes it relatively easy to opt into getting all sorts of notifications that might interest you. Sadly, it doesn’t make it easy to stop it from notifying you about things that aren’t of interest to you anymore: Either you can’t turn off a notification in the first place, or you have to visit every single thing that it notifies about and hit “Unsubscribe”. Not optimal!
In theory, it should be easier to filter github’s notification emails by relevance than it is to filter on their webface; at least with emails, you can use third-party filtering tools, right?1
If you’re using gmail, you’re shaking your head now (as I did): All the criteria that you could usefully use in gmail filters (From address, Subject, To address) are the same across all sorts of notifications you get from github. Ugh.
However, they do set a header field,
X-Github-Reason: It is set to
team_mention if the sole reason you’re getting an email is because
somebody mentioned one of your teams (not because you subscribed to an
issue on purpose, say). However, there’s a snag: Gmail can’t match on
that with its default filters.
Fortunately, Lyzi Diamond has written up a wonderful, and completely working solution to this problem using a mechanism that I was vaguely aware of in the past, but didn’t look at in detail: Google Apps Scripts.
(Go on, read her article; I’ll wait.)
Google Apps Scripts?!
In effect, Apps Scripts really powerful cron jobs that google runs for you, which can process your email.
My current github notification filter setup
So, as you may have gathered above, I have a Opinions on how a notification should affect my life:
If a person in the work org writes in about one of “my” issues or pull requests, I would like to know immediately (this means, the email should go into my inbox).
Same if they @-mention me personally. This probably means they’re blocked, or need help or are asking for a review.
If somebody @-mentions only a team I’m on, the email should be available under a label, but not go into my inbox.
I’ve modified Lyzi’s script for my purposes (also, I made it parse simple RFC822 headers, but not multi-line ones). The resulting script is in this gist.
Setting this up in your gmail account
This is a pretty manual process, sorry there’s no shell script you can pipe into bash (-:
- Create a gmail filter to match
from:email@example.com assigns a label (mine is
_github_incoming) and archives the email. (The google apps script will send github notifications to your inbox according to the criteria above!)
- Create a new script project and copy/paste the script from my gist as indicated in Lyzi’s blog post. It has screenshots! It’s great!
- Adjust the variables at the top to reflect the labels that you want email to be tagged with.
- Set up a trigger: I set mine up like this to call
processMessagesonce a minute:
- Set up notifications for that trigger: If anything should go wrong (I have a bug, there was a syntax error while pasting), you should get a notification. Click on “notifications” and set up a notification to email you hourly (or immediately if you like to get lots of email in case something goes wrong).
That’s it! Now your inbox should accumulate much less clutter!
I am pretty impressed with the things that Apps Scripts can let you do; my dream is a thing that cleans out email in small batches during off-hours (since bulk-deleting hundreds of thousands of messages can render your account unusable for hours). Maybe I’ll experiment with this soon!
- For my purposes, I’m focusing only on filtering out notifications that I’m getting solely because a team name that I’m on is @-mentioned in a pull request; you could imagine all sorts of other, more complex criteria! ↩
- Just look at the meager offerings in the public API for managing gmail filters; you can create filters… and that’s it. I could go on about this API for days. ↩