Skip to content

Latest commit

 

History

History
92 lines (50 loc) · 3.94 KB

README.md

File metadata and controls

92 lines (50 loc) · 3.94 KB
Raw

GitHub :octocat: 🔛 💌 Gmail

This is a Chrome and Firefox Extension that allows you to open threads in GitHub notification emails with a shortcut. ✨

Features

Mail View Shortcut

Open your GitHub notifications using a shortcut (default to shift + g, or shift + b to open in the background in Chrome), or this button in mail view:

image

List View Shortcut

The shortcut is ctrl + return(enter), currently non-customizable. It will trigger one of these two when an email is selected using key navigation(when the blue bar appears):

  1. Gmail action buttons.
  2. A GitHub Issue/ PR that has an organization named label matching the Regular Expression (default to ^\((.+)\)).

The function will only look for a label if there are no action buttons.

Action button

action button in list view

Label

label in list view

Installation

The Easy Way

Install the extension via Chrome webstore or Install the addon via Firefox addons gallery

The Mu-An-might-steal-all-my-data-so-I-want-to-manually-load-it Way (for Chrome)

  1. Go to Releases and download the latest version.
  2. Unzip the folder wherever you'd like.
  3. Read Mu-An's code making sure there is no data stealing.
  4. Go to Chrome extensions page (chrome://extensions/) and load the folder as an Unpacked extension.

As:

image

Options and preferences

There are 3 preference settings:

  1. Custom domains
  2. Mail view shortcut
  3. List view regular expression

Attention After updating a setting, please refresh both the extensions page and the Gmail page.

Custom Domains (for GitHub Enterprise)

If you are using GitHub enterprise and have a custom domain, you can set it in the extension options page.

domain option

Mail View Shortcut

Customize the keyboard shortcut that triggers the View on GitHub button. Change the shortcut combination by focusing the input, and press whatever key(s) you want to be the shortcut. It will be displayed in keyCode which is why you see 71 here instead of g. Don't worry about it.

To open and focus the new window right away (shift + g):

image

To open a new window in the background (shift + b) – Chrome only:

image

List View Regular Expression

Custom Regular Expression for matching labeled Organization name. Eg. /^\((.+)\)/ matches muan in (muan)\github-gmail, and will be use to build the url: https://github.com/muan/github-gmail/issues.

This is not needed if all you need is triggering the action button.

image

Code

Chrome: chrome/src/inject/inject.js.
Firefox: firefox/data/index.js.

The End

Love ❤️ it? Tell this little bird over at @muanchiou and I'll be thrilled.

Found a 🐛 bug? Open an issue with some emojis. Issues without emojis are not valid. :trollface: