taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Adds the Github module to the documentation

Browse Source
This commit is contained in:
Chris Cummer
2018-05-09 22:59:20 -07:00
parent c74db0177a
commit 33278dcc47
29 changed files with 377 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
_site/content/posts/modules/git.md
View File

@@ -74,7 +74,6 @@ git:
The number of past commits to display. <br />
Values: A positive integer, `0..n`.
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.

88
_site/content/posts/modules/github.md Normal file
View File

@@ -0,0 +1,88 @@
---
title: "Github"
date: 2018-05-09T19:20:20-07:00
draft: false
---
## Description
Displays information about git repositories hosted on Github: open
review requests, and open pull requests.
<img src="/imgs/modules/github.png" width="640" height="384" alt="github screenshot" />
#### Open Review Requests
Displays all open code review requests assigned to you.
#### Open Pull Requests
Displays all open pull requests created by you.
## Source Code
```bash
wtf/github/
```
## Required ENV Variables
<span class="caption">Key:</span> `WTF_GITHUB_TOKEN` <br />
<span class="caption">Action:</span> Your <a href="https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization">Github API</a> token.
## Keyboard Commands
<span class="caption">Key:</span> `/` <br />
<span class="caption">Action:</span> Open/close the widget's help window.
<span class="caption">Key:</span> `h` <br />
<span class="caption">Action:</span> Show the previous git repository.
<span class="caption">Key:</span> `l` <br />
<span class="caption">Action:</span> Show the next git repository.
<span class="caption">Key:</span> `←` <br />
<span class="caption">Action:</span> Show the previous git repository.
<span class="caption">Key:</span> `→` <br />
<span class="caption">Action:</span> Show the next git repository.
## Configuration
```yaml
github:
enabled: true
position:
top: 2
left: 3
height: 2
width: 2
refreshInterval: 300
repositories:
wesker-api: "UmbrellaCorp"
wtf: "senorprogrammer"
username: "senorprogrammer"
```
### Attributes
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
`position` <br />
Defines where in the grid this module's widget will be displayed. <br />
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, `0..n`.
`repositories` <br />
A list of key/value pairs each describing a Github repository to fetch data
for. <br />
<span class="caption">Key:</span> The name of the repository. <br />
<span class="caption">Value:</span> The name of the account or organization that owns the repository.
`username` <br />
Your Github username. Used to figure out which review requests you've
been added to.