wtf/_site/content/posts/modules/github.md

title, date, draft

title	date	draft
Github	2018-05-09T19:20:20-07:00	false

Displays information about git repositories hosted on Github: open review requests, and open pull requests.

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/

Required ENV Variables

Key: WTF_GITHUB_TOKEN
Action: Your Github API token.

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.

Configuration

github:
  enabled: true
  position:
    top: 2
    left: 3
    height: 2
    width: 2
  refreshInterval: 300
  repositories:
    wesker-api: "UmbrellaCorp"
    wtf: "senorprogrammer"
  username: "senorprogrammer"

Attributes

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
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.

username
Your Github username. Used to figure out which review requests you've been added to.