DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:ghissues

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:ghissues [2014-10-09 23:52] – [Examples/Usage] zsmith12plugin:ghissues [2023-02-28 21:11] (current) Aleksandr
Line 1: Line 1:
-====== ghissues Plugin ======+====== GHIssues Plugin ======
  
 ---- plugin ---- ---- plugin ----
-description: Uses the GitHub API(v3) to access and display issues from the bug tracker.+description: Uses the GitHub API (v3) to access and display issues from the bug tracker
 author     : zsmith12  author     : zsmith12 
 email      : zsmith12@umd.edu  email      : zsmith12@umd.edu 
 type       : syntax, helper, action type       : syntax, helper, action
-lastupdate : 2014-10-08 +lastupdate : 2014-10-18 
-compatible : Ponder Stibbons+compatible : Ponder Stibbons, !Greebo
 depends    :  depends    : 
 conflicts  conflicts 
-similar    :  +similar    : issuelinks 
-tags       : github, issues, bugtracker, tracker+tags       : github, issue, bugtracker, tracker
  
 downloadurl: https://github.com/ZJ/ghissues/zipball/master downloadurl: https://github.com/ZJ/ghissues/zipball/master
Line 18: Line 18:
 donationurl:  donationurl: 
  
-screenshot_img : +screenshot_img : http://i.imgur.com/MxlyOc3.png
 ---- ----
  
 ===== Description ===== ===== Description =====
  
-Allows the insertion of a table showing issues from the bug tracker on a GitHub repository.  Filtering by state (open/closed/all) and label are supported.  The table shows issue number, title, any labels (with their assigned colors) as well as creation date/time and creator.+Allows the insertion of a table showing issues from the bug tracker on a GitHub repository. Filtering by state (open/closed/all) and label are supported. The table shows issue number, title, any labels (with their assigned colors) as well as creation date/time and creator.
  
 Each issue title is also a link to the appropriate issue page on GitHub, and there is a link to the table's equivalent issues search in the footer of the table. Each issue title is also a link to the appropriate issue page on GitHub, and there is a link to the table's equivalent issues search in the footer of the table.
Line 31: Line 31:
 ===== Installation ===== ===== Installation =====
  
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
 ===== Examples/Usage ===== ===== Examples/Usage =====
-Below are code snippets and static screenshots of the plugin's output with data from the [[http://github.com/splitbrain/dokuwiki|DokuWiki Repository]] on GitHub((Example data pulled on 2014-10-09 16:00 EST)).+ 
 +Below are code snippets and static screenshots of the plugin's output with data from the [[https://github.com/dokuwiki/dokuwiki|DokuWiki Repository]] on GitHub((Example data pulled on 2014-10-09 16:00 EST)). 
 ==== Open Issues for a Label ==== ==== Open Issues for a Label ====
-<code>{{ghissues splitbrain/dokuwiki label:Beginner's Project}}</code>+ 
 +<code>{{ghissues dokuwiki/dokuwiki label:Beginner's Project}}</code>
 {{http://i.imgur.com/MxlyOc3.png}} {{http://i.imgur.com/MxlyOc3.png}}
  
 ==== Open Issues with Both Labels ==== ==== Open Issues with Both Labels ====
-<code>{{ghissues splitbrain/Dokuwiki label:feature,Beginner's Project}}</code>+ 
 +<code>{{ghissues dokuwiki/Dokuwiki label:feature,Beginner's Project}}</code>
 {{http://i.imgur.com/x7kalRs.png}} {{http://i.imgur.com/x7kalRs.png}}
  
 ==== All (Open & Closed) Issues for a Label ==== ==== All (Open & Closed) Issues for a Label ====
-<code>{{ghissues splitbrain/Dokuwiki state:all label:feature}}</code>+ 
 +<code>{{ghissues dokuwiki/Dokuwiki state:all label:feature}}</code>
 {{http://i.imgur.com/WnYfbDT.png}} (Trimmed the bottom because the list is long) {{http://i.imgur.com/WnYfbDT.png}} (Trimmed the bottom because the list is long)
  
 ==== Closed Issues for a Label ==== ==== Closed Issues for a Label ====
-<code>{{ghissues splitbrain/Dokuwiki state:closed label:feature}}</code>+ 
 +<code>{{ghissues dokuwiki/Dokuwiki state:closed label:feature}}</code>
 {{http://i.imgur.com/1NMf63S.png}} {{http://i.imgur.com/1NMf63S.png}}
 +
 ===== Syntax ===== ===== Syntax =====
  
Line 58: Line 65:
  
   * **''%%{{ghissues%%''** //(required)// marks the start   * **''%%{{ghissues%%''** //(required)// marks the start
-  * **''<repository>''** //(required)// gives the repository whose issues you'd like to list.  Given in ''user/repo'' format, e.g. ''ZJ/ghissues'' +  * **''<repository>''** //(required)// gives the repository whose issues you'd like to list. Given in ''user/repo'' format, e.g. ''ZJ/ghissues'' 
-  * **''state:<>''** //(optional)// Case sensitive.  ''state:'' indicates you'd like to filter by state, and ''<>'' can be followed by one of (all lowercase):+  * **''state:<>''** //(optional)// Case sensitive. ''state:'' indicates you'd like to filter by state, and ''<>'' can be followed by one of (all lowercase):
     * **''all''**     * **''all''**
     * **''open''**     * **''open''**
     * **''closed''**     * **''closed''**
-  * **''%%label:<>%%''** //(optional)// comma-separated list of labels to filter by.  Labels are filtered using AND, i.e. on issues with both ''label1'' //AND// ''label2'' would be shown if you entered ''label:label1,label2'' **//There should be no space between the last label and the closing braces//**+  * **''%%label:<>%%''** //(optional)// comma-separated list of labels to filter by. Labels are filtered using AND, i.e. on issues with both ''label1'' //AND// ''label2'' would be shown if you entered ''label:label1,label2''. **//There should be no space between the last label and the closing braces//**
   * **''%%}}%%''** //(required)// closes the pattern.   * **''%%}}%%''** //(required)// closes the pattern.
  
Line 70: Line 77:
 Three user settings are available. Three user settings are available.
  
-  * **"GitHub Cache Expiry Interval (seconds)"** sets how long DokuWiki waits before making another GitHub API request.  The timer is applied on a per-request URL basis. +  * **"GitHub Cache Expiry Interval (seconds)"** sets how long DokuWiki waits before making another GitHub API request. The timer is applied on a per-request URL basis. 
-  * **"GitHub Account Username"** sets a user name that is sent along with GitHub API requests.   +  * **"GitHub Account Username"** sets a user name that is sent along with GitHub API requests. 
-  * **"GitHub Personal OAuth Token"** To increase GitHub's rate limit from 60/hour to 5000/hour, you can provide a personal OAuth token here.  More info below.+  * **"GitHub Personal OAuth Token"** To increase GitHub's rate limit from 60/hour to 5000/hour, you can provide a personal OAuth token here. More info below.
  
 ==== OAuth Token ==== ==== OAuth Token ====
  
-GitHub allow authentication via [[https://github.com/blog/1509-personal-api-tokens|personal OAuth tokens]] which can be generated at https://github.com/settings/applications .  This is nice because it avoids having to provide a username/password combination.  You can also [[https://developer.github.com/v3/oauth/#scopes|control which parts of your account a token has access to]].+GitHub allow authentication via [[https://github.com/blog/1509-personal-api-tokens|personal OAuth tokens]] which can be generated at https://github.com/settings/applications. This is nice because it avoids having to provide a username/password combination. You can also [[https://developer.github.com/v3/oauth/#scopes|control which parts of your account a token has access to]].
  
 === Do I need to use Oauth Tokens? === === Do I need to use Oauth Tokens? ===
  
-Short answer: probably not.  There are two reasons to use one:+Short answer: probably not. There are two reasons to use one:
  
-  - You want to look at issues from _private_ repositories.  To do this, you'll need an OAuth token for an account that has access to those repositories+  - You want to look at issues from //private// repositories. To do this, you'll need an OAuth token for an account that has access to those repositories
   - You need >60 requests per hour.   - You need >60 requests per hour.
-   + 
-This plugin does its best to minimize the number of requests it makes.  It implements cacheing on DokuWiki's side together with conditional HTTP requests.  The quick-and-dirty rule is that you'll generate 1 request per unique table per change to an issue on GitHub's side.+This plugin does its best to minimize the number of requests it makes. It implements cacheing on DokuWiki's side together with conditional HTTP requests. The quick-and-dirty rule is that you'll generate 1 request per unique table per change to an issue on GitHub's side.
  
 ===== Development ===== ===== Development =====
plugin/ghissues.1412891575.txt.gz · Last modified: 2014-10-09 23:52 by zsmith12

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki