diff --git a/_site/content/posts/modules.md b/_site/content/posts/modules.md index be7f70ae..6a198596 100644 --- a/_site/content/posts/modules.md +++ b/_site/content/posts/modules.md @@ -23,7 +23,7 @@ Available modules:
  • BambooHR
  • Clocks
  • Git -
  • Github +
  • Github
  • Google Calendar
  • Jira
  • New Relic diff --git a/_site/content/posts/modules/git.md b/_site/content/posts/modules/git.md index 1276c67d..63f79c0f 100644 --- a/_site/content/posts/modules/git.md +++ b/_site/content/posts/modules/git.md @@ -74,7 +74,6 @@ git: The number of past commits to display.
    Values: A positive integer, `0..n`. - `enabled`
    Determines whether or not this module is executed and if its data displayed onscreen.
    Values: `true`, `false`. diff --git a/_site/content/posts/modules/github.md b/_site/content/posts/modules/github.md new file mode 100644 index 00000000..234ff3f5 --- /dev/null +++ b/_site/content/posts/modules/github.md @@ -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. + +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 + +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 + +```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`
    +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. diff --git a/_site/static/imgs/modules/github.png b/_site/static/imgs/modules/github.png new file mode 100644 index 00000000..0414537b Binary files /dev/null and b/_site/static/imgs/modules/github.png differ diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html index 30479fbf..d87588b0 100644 --- a/_site/themes/hyde-hyde/layouts/partials/sidebar.html +++ b/_site/themes/hyde-hyde/layouts/partials/sidebar.html @@ -20,7 +20,7 @@
  • BambooHR
  • Clocks
  • Git
    • -
  • Github
    • +
  • Github
  • Google Calendar
  • Jira
  • New Relic
    • diff --git a/docs/404.html b/docs/404.html index 3444249c..29021368 100644 --- a/docs/404.html +++ b/docs/404.html @@ -60,7 +60,7 @@
  • BambooHR
  • Clocks
  • Git
    • -
  • Github
    • +
  • Github
  • Google Calendar
  • Jira
  • New Relic
    • diff --git a/docs/categories/index.html b/docs/categories/index.html index c65b7349..7cae3375 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -62,7 +62,7 @@
  • BambooHR
  • Clocks
  • Git
    • -
  • Github
    • +
  • Github
  • Google Calendar
  • Jira
  • New Relic
    • diff --git a/docs/imgs/modules/git.png b/docs/imgs/modules/git.png new file mode 100644 index 00000000..08772695 Binary files /dev/null and b/docs/imgs/modules/git.png differ diff --git a/docs/imgs/modules/github.png b/docs/imgs/modules/github.png new file mode 100644 index 00000000..0414537b Binary files /dev/null and b/docs/imgs/modules/github.png differ diff --git a/docs/index.html b/docs/index.html index c4c04d31..688951c5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -61,7 +61,7 @@
  • BambooHR
  • Clocks
  • Git
    • -
  • Github
    • +
  • Github
  • Google Calendar
  • Jira
  • New Relic
    • diff --git a/docs/index.xml b/docs/index.xml index bb0186cf..6796a58e 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,25 @@ Recent content on WTF Hugo -- gohugo.io en-us - Wed, 09 May 2018 14:20:48 -0700 + Wed, 09 May 2018 19:20:20 -0700 + + Github + http://wtfutil.com/posts/modules/github/ + Wed, 09 May 2018 19:20:20 -0700 + + http://wtfutil.com/posts/modules/github/ + Description Displays information about git repositories hosted on Github: open review requests, and open pull requests. +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 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. + + Git http://wtfutil.com/posts/modules/git/ diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html index 28e6fe2a..b5fb3d69 100644 --- a/docs/posts/configuration/index.html +++ b/docs/posts/configuration/index.html @@ -60,7 +60,7 @@
  • BambooHR
  • Clocks
  • Git
    • -
  • Github
    • +
  • Github
  • Google Calendar
  • Jira
  • New Relic
    • diff --git a/docs/posts/glossary/index.html b/docs/posts/glossary/index.html index ea7c9142..8ad5d3cc 100644 --- a/docs/posts/glossary/index.html +++ b/docs/posts/glossary/index.html @@ -60,7 +60,7 @@
  • BambooHR
  • Clocks
  • Git
    • -
  • Github
    • +
  • Github
  • Google Calendar
  • Jira
  • New Relic
    • diff --git a/docs/posts/index.html b/docs/posts/index.html index c7652010..6524700e 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -62,7 +62,7 @@
  • BambooHR
  • Clocks
  • Git
    • -
  • Github
    • +
  • Github
  • Google Calendar
  • Jira
  • New Relic
    • @@ -89,6 +89,13 @@

    Posts