Github Connect puts your GitHub notifications, pull requests, Actions runs, issues and contribution graph on the XENEON EDGE. The widget gets its data through Qaem Hub, a free app for Windows, which also holds your GitHub sign-in. You install Qaem Hub, import the widget, then approve a code on github.com: there's no password to type and no token to paste.
Before you start
Setup
Install Qaem Hub and add Github Connect
- Download Qaem Hub Setup.exe and run it. It installs for your Windows account and starts with Windows. The Qaem Hub setup guide covers the installer and the SmartScreen warning.
- In Qaem Hub, open Add modules, select Github Connect and click Install selected.
If you don't see Github Connect in the list, skip ahead: when the widget is on your EDGE, tap Open in Qaem Hub on it, and Qaem Hub opens with the module already picked. More about the app is on the Qaem Hub page.
Get and import the widget
- Get the
.icuewidgetfile from the Elgato Marketplace. If you bought Github Connect here on qaemdev.com, it's under Account → Downloads. The product page links to both. - Double-click the file, and iCUE imports it.
- If nothing happens, open iCUE, go to the Widgets section for your EDGE, use the + button and choose the file.
Place it and pick its Widget type
Drag Github Connect onto a screen area of your EDGE. It lays itself out for any size, horizontal or vertical.
Its settings appear beside the layout in iCUE. Pick a Widget type: Notifications, Pull requests, Actions runs, Issues, Repository, Contributions or Profile. Then pick a Design: List, Glance, Cards or Terminal. Add the widget more than once to give each copy its own job.
Allow the widget in Qaem Hub
The first time the widget reaches Qaem Hub, it shows Allow this widget in Qaem Hub and a 4-digit code. Qaem Hub shows the widget's name and a code too.
- Check that the two codes match.
- Click Allow in Qaem Hub.
You do this once: every copy of Github Connect shares the approval.
Connect GitHub
On the EDGE, tap Connect GitHub. You can also start it from the Github Connect module in Qaem Hub.
- GitHub's device page opens in your PC's browser, and the widget shows a code and a QR code.
- Enter the code on github.com, or scan the QR code with your phone and approve there.
- Approve QaemDev. The widget shows Connected as @yourname and loads your data.
If the browser didn't open, tap Open on this PC, or go to the address shown on the widget and enter the code.
Make each copy yours
Tap the gear in the widget's header to open its Settings. The Show tab holds what iCUE can't: the kind of notification (reviews, mentions, CI and more), your pull requests or the ones waiting for your review, which issues, and up to six repositories for Actions runs, with a branch and only failed or running runs if you like. With no repositories picked, Actions shows the three you pushed to last.
Behaviour sets what a tap and a hold do, and how often the widget refreshes. Colours has your own colours for passing, failing, running and unread. The GitHub tab shows who you're signed in as, how many GitHub calls are left this hour, and Disconnect.
What it can access
When you connect, GitHub asks for three permissions:
read:user: your profile and contribution graph.notifications: your notifications, and marking them read.repo: your repositories, including private ones, for pull requests, issues and Actions runs, and re-running a run.
GitHub's repo permission covers more than the widget uses. Qaem Hub only sends GitHub the requests the widget needs: reading these feeds, marking notifications read and re-running an Actions run. The widget can't make any other request.
The sign-in stays in Qaem Hub, encrypted on your PC. The widget never sees it, and only widgets you allow can use it. Qaem Hub talks to GitHub directly from your PC.
Good to know
- Tap and hold. By default a tap opens the item on GitHub and a hold marks a notification read. Holding a finished Actions run re-runs it, only its failed jobs when it failed. The widget asks first.
- Live runs. Running Actions runs refresh every 20 seconds. Notifications wait as long as GitHub asks, and everything else follows the refresh you pick.
- GitHub's hourly limit. GitHub allows 5,000 calls an hour per account. Qaem Hub asks once for every copy that shows the same thing, and only fetches again when something changed.
- Disconnect in the widget's GitHub tab or in Qaem Hub forgets the sign-in on your PC. To revoke QaemDev's access as well, go to Settings → Applications on github.com.
Troubleshooting
The widget says Qaem Hub isn't running
Tap Start Qaem Hub, or open it from the tray or the Start menu. If it isn't installed, Get Qaem Hub takes you to the download. If the widget says Turn on Github Connect in Qaem Hub, tap Open in Qaem Hub, then add the module or switch it on in Library. If it says Update Qaem Hub, install the newest version.
It says Not allowed
You clicked Deny in Qaem Hub, or nobody answered in time. If nobody answered, tap Ask again. If you denied it, open Github Connect's details in Qaem Hub and click Reset under Widgets, then allow it.
The code ran out, or the sign-in was declined
Codes are valid for a limited time. Tap Connect GitHub again for a fresh one.
It says Sign in to GitHub again
GitHub no longer accepts the sign-in, for example because the access was revoked on github.com. Tap Connect again and approve a new code.
Private repositories are missing, or re-running doesn't work
Your sign-in predates a permission the widget now uses. The GitHub tab in Settings says which one is missing. Tap Connect again there.
GitHub's hourly limit is used up
Every Github Connect on your PC shares one hourly allowance. The widget comes back on its own when GitHub resets it. A slower refresh in Behaviour helps if it happens often.
It says Can't reach GitHub
Your PC can't reach GitHub right now. Check your connection, then tap Try again.