GitHub

Displays information about your git repositories hosted on GitHub:

Open Review Requests

All open code review requests assigned to you.

Open Pull Requests

All open pull requests created by you.

Source Code

wtf/github/

Keyboard Commands

Key: /
Action: Open/close the widget’s help window.

Key: h
Action: Show the previous git repository.

Key: l
Action: Show the next git repository.

Key: ←
Action: Show the previous git repository.

Key: →
Action: Show the next git repository.

Key: Return
Action: Open the selected repository in a browser.

Configuration

github:
  apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
  baseURL: ""
  enabled: true
  enableStatus: true
  position:
    top: 2
    left: 3
    height: 2
    width: 2
  refreshInterval: 300
  repositories:
    wesker-api: "UmbrellaCorp"
    wtf: "senorprogrammer"
  uploadURL: ""
  username: "senorprogrammer"

Attributes

apiKey
Value: Your GitHub API token.

baseURL
Optional
Value: Your GitHub Enterprise API URL.

enabled
Whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

enableStatus
Display pull request mergeability status (‘dirty’, ‘clean’, ‘unstable’, ‘blocked’).
Values: true, false.

position
Defines where in the grid this module’s widget will be displayed.

refreshInterval
How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.

repositories
A list of key/value pairs each describing a GitHub repository to fetch data for.
Key: The name of the repository.
Value: The name of the account or organization that owns the repository.

uploadURL
Optional
Value: Your GitHub Enterprise upload URL (often the same as API URL).

username
Your GitHub username. Used to figure out which review requests you’ve been added to.