Extension:JiraBugReport

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
JiraBugReport

Release status: stable

Implementation Tag
Description Adds tag to report issues in a Jira issue tracker.
Author(s) Stéphane GALLAND (sgalland-arakhnetalk)
Latest version 1.0
License GPL
Download http://www.arakhne.org/mediawiki/JiraBugReport/ Download link on destination page gives 404 error.

Translate the JiraBugReport extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

Description[edit | edit source]

JiraBugReport extension is used to embed a bug report formular to the JIRA issue tracker in a MediaWiki page. The proposed formular is more simple than the original JIRA bug report formular but it provides the essiential features.

Example: http://www.janus-project.org/index.php/Bug_Report.

Requirements[edit | edit source]

JiraBugReport extension uses the reCAPTCHA library. You must obtain a key for your website to activate reCAPTCHA (it's free, you only need a Google account).

Installation[edit | edit source]

  1. Download JiraBugReport,
  2. Unpack the archive in your Mediawiki directory
  3. add require_once('extensions/JiraBugReport/JiraBugReport.php'); in your LocalSettings.php.


Configuration[edit | edit source]

The JiraIssueList extension uses a SOAP connexion to the JIRA issue tracker. You must enable this feature in your JIRA configuration panel. The JiraBugReport extension uses the reCAPTCHA library to avoid robots to post issues. Please obtain an activation key for reCAPTCHA.

JiraBugReport extension uses several global variables which may be set in LocalSetting.php:

  • $jiraHost
    Defines the URL of the Jira website which is providing SOAP service.
  • $jiraUser
    Defines the login to use to be connected to the JIRA SOAP service.
  • $jiraPass
    Defines password of the account to use to be connected to the JIRA SOAP service.
  • $wgJiraBugReportHowToPage
    Defines the wiki page which explains how to use the formular.
  • $wgJiraBugReportHelpIcon
    Defines the browser path to render an help icon.
  • $recaptcha_public_key
    Defines public key to be used by reCAPTCHA.
  • $recaptcha_private_key
    Defines private key to be used by reCAPTCHA.

Usage[edit | edit source]

JiraBugReport provides the tag <jirabugreport />. This tag is expanded to a formular to submit issue to the JIRA issue tracker.

<jirabugreport> projectName </jirabugreport>:

  • projectName is the name of the project on the JIRA SOAP service.