Skip to content
This repository
tree: 5a4db4a462

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

MediaWiki extension for Bugzilla

This is a MediaWiki extension that provides read-only access to the Bugzilla REST API

Please note that this isn't finished / ready for production yet!

Requirements

  • Requires HTTP_Request2 from PEAR
  • Requires the SMARTY template library installed

Installation

These directions assume your MediaWiki installation is at /var/lib/mediawiki. Please substitute your installation path if it is different

  1. Install the requirements above
  2. Check the project out into /var/lib/mediawiki/extensions/Bugzilla
  3. Edit /etc/mediawiki/LocalSettings.php and add require_once("/var/lib/mediawiki/extensions/Bugzilla/Bugzilla.php");
  4. Edit /etc/mediawiki/LocalSettings.php and change/override any configuration variables. Current configuration variables and their defaults can be found at the end of Bugzilla.php
  5. Run the MediaWiki update script to create the cache database table php /var/lib/mediawiki/maintenance/update.php. *Note that you may need to add $wgDBadminuser and $wgDBadminpassword to /etc/mediawiki/LocalSettings.php depending on your MediaWiki version

Usage

You use this extension in this way:

<bugzilla>
    (JSON REST API query key/value pairs)
</bugzilla>

An example:

<bugzilla>
    {
        "product": "Bugzilla",
        "priority":"P1"
    }
</bugzilla>

For more details on how to query in various ways, see the documentation for the Bugzilla REST API

Note that the tag name defaults to "bugzilla" but is configurable.

There is also exploratory support for charting:

<bugzilla type="count" display="bar">
    {
        "product":      "Bugzilla",
        "priority":     "P1",
        "x_axis_field": "severity"
    }
</bugzilla>

Screenshot of the above:

Screenshot of the above

Limitations

  • This extension (by design) is read-only
  • This extension currently queries as a public (not logged in) user
  • Charts are fairly hardcoded and don't work in many cases

TODO

  1. This is basically a prototype right now...needs to be cleaned up a lot
  2. The JQuery UI table doesn't render correctly...make it better
  3. Support more types of queries than just "bug" (the default)
  4. Support more types of wiki display than just a bug table
  5. Caching and cache invalidation for queries
  6. Support charting as a 1st class citizen
Something went wrong with that request. Please try again.