mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
87 lines
2.2 KiB
Markdown
87 lines
2.2 KiB
Markdown
---
|
|
title: "GitHub"
|
|
date: 2018-05-09T19:20:20-07:00
|
|
draft: false
|
|
---
|
|
|
|
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.
|
|
|
|
<img src="/imgs/modules/github.png" width="640" height="384" alt="github screenshot" />
|
|
|
|
## 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: "andrewzolotukhin"
|
|
username: "andrewzolotukhin"
|
|
```
|
|
|
|
### 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.
|