Git Desk for GitHub

Your GitHub on the TC002, at a glance. It shows:

• what waits for you;
• whether your pull requests can be merged;
• whether your builds are green.

When a build turns red, the clock tells you before anyone else does.

What you see

Press the knob for the next view, turn it for the items of a view.

• Overview: four tiles with their own signs and large digits that roll like a counter. They show unread notifications, review requests, the builds (a check, a cross with the number of red ones, or a turning ring while one runs) and your streak of days with contributions. A tile pulses when its number changes.
• Heatmap: your last 52 weeks, a column a week and two rows a day, in five shades of green. It builds in week by week, then the year's total counts up next to your streak. Today blinks. Turn the knob to walk through the days: the date and that day's count appear.
• Inbox: one unread notification at a time. It shows what kind it is, in the colour of why you got it, the repo, why ("review", "mentioned", "assigned", "CI") and the title. Hold the knob to mark it read on GitHub: a gold check, and the next one wipes in.
• Pull requests: first the reviews requested of you, then your own, each with its state: ready, CI red, conflict, waiting, behind or draft.
• Actions: the last run of each repo you watch, red ones first, with workflow, branch and how long ago.
• Repos: stars that roll up, +3 for new ones since the last look, forks, issues and the latest release. Passing 10, 25, 50, 100, 250, 500, 1000 … stars brings fireworks.

Alarms

• A build turns red:
  • Git Desk comes to the front with a pulsing red sign and a low two-tone.
  • With speech on, the clock also says "Build failed in weather-station" (in English).
  • When the build is green again, a green "FIXED" follows.
• Notes over any app, each only once: a new review request, a mention or assignment, a new release, a star milestone.
• Quiet hours (22 to 7 by default): no sound and no takeover.

Setup

Signed in (everything):

1. Create a free OAuth app at github.com/settings/developers (OAuth Apps → New OAuth app) with the callback URL https://awtrix.de/oauth/callback.
2. Generate a client secret.
3. Enter the Client ID and the secret in the app's settings and press Sign in.

The app asks for notifications, read:user and repo. It needs repo only for private repos; the README shows how to sign in with public_repo instead. The token stays on the clock.

Only a user name: enter your GitHub user name in the settings. You get your public repos: stars, Actions and releases. GitHub allows 60 requests an hour without sign-in, which Git Desk stays within.

Settings

Buttons and knob

• Turn: through the items of the view.
• Press: the next view. Press twice: the view before.
• Hold: mark read in the inbox; elsewhere back to the start view.
• SELECT: fetch again now.
• Left / Right: switch apps, as always.

Good to know

• Easy on GitHub: about 500 requests an hour with 6 repos, a tenth of what GitHub allows. Notifications are asked with If-Modified-Since, so "nothing new" costs nothing.
• When GitHub asks to wait (rate limit), the app keeps what it has and waits 15 minutes.
• Without a connection a grey corner shows and the numbers stay. After a restart, the last numbers are there at once.
• Revoked sign-in: "Sign in again" along the top.
• For other apps: gitdesk.unread, .reviews, .ci (0 green, 1 red, 2 running), .failed, .streak, .today and .stars in the shared values, e.g. for a lamp that turns red with a red build.

Compatible with GitHub; not made or endorsed by GitHub. GitHub is a trademark of GitHub, Inc.