GitHub

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.

Custom Queries

Create filters to manage PRs and issues however you like.

Configuration


github:
  apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
  baseURL: ""
  customQueries:
    othersPRs:
      title: "Others Pull Requests"
      filter: "is:open is:pr -author:wtfutil"
  enabled: true
  enableStatus: true
  position:
    top: 2
    left: 3
    height: 2
    width: 2
  refreshInterval: 300
  repositories:
    - "wtfutil/wtf"
    - "wtfutil/docs"
    - "umbrella-corp/wesker-api"
  uploadURL: ""
  username: "wtfutil"

Screenshots

github screenshot

Attributes

Name Description Value
apiKey Your GitHub API token. Your API key or leave it empty to use the WTF_GITHUB_TOKEN environment variable.
baseURL Optional Your GitHub Enterprise API URL. Your API URL or leave it empty to use the WTF_GITHUB_BASE_URL environment variable.
border Optional Whether or not to draw this widget with a border. Default: true. true, false
customQueries Filters for pull requests and issues.
enabled Optional Whether or not this module is executed and if its data displayed onscreen. Default: false. true, false
enableStatus Whether or not to display pull request mergeability status (dirty, clean, unstable, blocked). true, false
focusChar Optional Define one of the number keys as a short cut key to access the widget. 0..9
position Defines where in the grid this module's widget will be displayed.
refreshInterval Optional How often, in seconds, this module will update its data. Default: 300. Any positive integer
repositories A list of github repos to fetch data for.
showMyPullRequests Optional Whether or not to display the ‘My Pull Requests’ section. Default: true. true or false
showOpenReviewRequests Optional Whether or not to display the ‘Open Review Requests’ section. Default: true. true or false
showStats Optional Whether or not to display the ‘Stats’ section. Default: true. true or false
uploadURL Optional Your GitHub Enterprise upload URL (often the same as the API URL). Your API URL or leave it empty to use the WTF_GITHUB_UPLOAD_URL environment variable.
username Your GitHub username.

Keyboard Controls

Key Action
`/` Open/close the widget's help modal
`[return]` Open the selected Pull Request or Issue in the browser
`[insert]` Open the selected repository in the browser
`h` Show the previous git repository
`i` Open the selected Issue in the browser
`j` Select the next item in the list
`k` Select the previous item in the list
`l` Show the next git repository
`p` Open the selected Pull Request in the browser
`r` Refresh the data
`↑` Select the previous item in the list
`↓` Select the next item in the list
`←` Show the previous git repository
`→` Show the next git repository

Custom Query Examples

Custom queries allow you to filter pull requests and issues however you like. Give the query a title and a filter. Filters can be copied directly from GitHub’s UI.


customQueries:
  othersPRs:
    # Displays pull requests that are not assigned to you
    title: "Others Pull Requests"
    filter: "is:open is:pr -author:[your github username]"
  openIssues:
    # Displays issues that are assigned to you
    title: "My Issues"
    filter: "is:issue state:open author:[your github username]"
  otherIssues:
    # Displays issues not assigned to you, order by their updated_at date
    perPage: 10
    title: "Others Issues"
    filter: "is:issue state:open -author:[your github username] sort:updated-desc"

Source Code

https://github.com/wtfutil/wtf/tree/master/modules/github/