JIKI - Embed a list of issues from a JIRA instance into a Mediawiki wiki page. Configuration

In mediawiki LocalSettings specify the JIRA Hostname:

$jikiJiraHost     = "https://jira.atlassian.com";

Specify the JIRA User Name:

$jikiJiraUser     = "[email protected]";

Specify the JIRA User Password:

$jikiJiraPassword = "ILoveC@ts";

Specify any custom fields you have in your JIRA:

$jikiExtraParams = array
  (
    array("param"=>"myParamNameInWiki","jql"=>"\"My Field Name in JIRA\""),
  );

Optionally define another field to use in place of description for the full details view (has to come before require of Jiki.php file in LocalSettings.php)

$jikiFullDetailsField = "customfield_10800";

Basic Use

In any wiki page include the following tag:

<jira></jira>

Filtering

As long as the field is a basic JIRA field or you have configured it in LocalSettings:

<jira project="GO,FP,HELP"></jira>

<jira>text to search for</jira>

<jira project="GO" reporter="gvoss"></jira>

Or for an advanced user or where the JIKI implementation of JQL is insufficient:

<jira jql="project = GO AND reporter in (gvoss)"></jira>

Default Filter Fields

1. id - synonymous with key
2. key - the Key of the issue (e.g. ABCD-1234)
3. issuetype - the type of issue (e.g. bug)
4. project - the key of the project (e.g. ABCD)
5. fixversion - the fix version (e.g. 1.0.0)
6. affectedversion - the affected version (e.g. 1.0.0)
7. reporter - username of the reporter (e.g. gvoss)
8. assignee - username of the assignee (e.g. gvoss)
9. status - name of the status (e.g. In Progress)
10. sprint - ID or exact name of the sprint (e.g. 786)
11. resolution - status of the resolution (e.g. resolved)
12. labels - any labels applied to the issues (e.g. cats)
13. component - any components applied to the issues (e.g. content management)
14. epiclink - name of the epic link (e.g. loading screen)

Formatting

The following parameters exist to allow controlling of format:

1. jikiformat - allows you to control the formating

<jira jikiformat="html"></jira>

1. jikifulldetails - allows you to control how much detail is printed to the screen

<jira jikifulldetails="true"></jira>