Diff for "Bugs/TracPlugin"

Not logged in - Log In / Register

Differences between revisions 2 and 3
Revision 2 as of 2008-08-20 08:29:49
Size: 3944
Editor: gmb
Comment:
Revision 3 as of 2008-08-20 13:53:59
Size: 5173
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= Installing the Launchpad plugin for Trac = ~-[[FrontPage|Launchpad Help]] > [[Bugs]] > Launchpad-Trac plugin -~

= Overview =

Launchpad can communicate directly with bug trackers that use Trac through the [[http://launchpad.net/trac-launchpad|trac-launchpad]] plugin.

If you run a Trac instance, you can use the plugin to:

 * share comment histories between bugs that are tracked both in your Trac tracker and also in Launchpad
 * reduce the server load of bug watches from Launchpad.

To start using the plugin, you need to install it in your Trac environment and also tell Launchpad that you're using the plugin.

= Installation =
Line 16: Line 29:
You can download the plugin from it's [[https://edge.launchpad.net/trac-launchpad/+download|Launchpad project page]]. You can download the plugin from its [[https://edge.launchpad.net/trac-launchpad/+download|Launchpad project page]].
Line 22: Line 35:
If you're using Trac 0.10 you need to apply the patches provided in the 0.10-patches
directory of the trac-launchpad tarball to your current Trac installation:
If you're using Trac 0.10 you need to apply the patches, provided in the 0.10-patches
directory of the trac-launchpad tarball, to your current Trac installation:
Line 30: Line 43:
== Systemwide Installation == == Systemwide installation ==
Line 32: Line 45:
To install the plugin, unpack the tarball to /tmp and run `python setup.py install` within the unpacked directory: To install the plugin, unpack the tarball to `/tmp` and run `python setup.py install` in the unpacked directory:
Line 44: Line 57:
To activate the plugin in a specific Trac instance, edit $TRAC_ENV/conf/trac.ini and add the following lines: To activate the plugin in a specific Trac instance, edit `$TRAC_ENV/conf/trac.ini` and add the following lines:
Line 67: Line 80:
log in with TRAC_ADMIN privileges and then visit $YOUR_TRAC_URL/plugins if log in with TRAC_ADMIN privileges and then visit `$YOUR_TRAC_URL/plugins` if
Line 71: Line 84:
== Getting Launchpad to work with your bugtracker ==  Getting Launchpad to work with your bugtracker =
Line 73: Line 86:
Once the plugin is installed and working you need to register your bugtracker with Launchpad if it isn't already registered. This is really simple to do: Once the plugin is installed and working you need to register your bugtracker with Launchpad, if it isn't already registered.
Line 75: Line 88:
 1. Go to http://launchpad.net/bugs/bugtrackers
 2. Check to see if your bugtracker is registered. If it isn't, click the "Register another bugtracker" link at the bottom of the page.
 3. Enter your bugtracker's details and click the "Add" button.
 4. Your bug tracker should now show up in the list of registered bugtrackers (http://launchpad.net/bugs/bugtrackers).
 5. If there are bugs in Launchpad that can be linked to your bug tracker, link them!
 6. If there aren't any bugs in Launchpad you can go to http://staging.launchpad.net and file some test bugs which you can then link to your bugtracker. Remember that staging's database is reset every day, so don't forget to email the Launchpad team at feedback@launchpad.net and let them know that you've filed some bugs for testing. They can then run the bug watch checker against your bug tracker. <<BR>>'''Note''': You may have to wait a day or so for your bugtracker to show up on staging. Alternatively, you can set it up manually by following steps 1-4 but substitute http://staging.launchpad.net for http://launchpad.net where appropriate.
This is really simple to do:
Line 82: Line 90:
'''Step 1:''' Visit https://launchpad.net/bugs/bugtrackers

'''Step 2:''' Check to see if your bugtracker is registered. If it isn't, click the [[https://edge.launchpad.net/bugs/bugtrackers/+newbugtracker|Register another bugtracker]] link at the bottom of the page.

'''Step 3:''' Enter your bugtracker's details and click the ```Add``` button.

'''Step 4:''' Your bug tracker should now show up in the list of [[http://launchpad.net/bugs/bugtrackers|registered bugtrackers]].

'''Step 5:''' Look through Launchpad to find bugs that are being tracked in Launchpad that are also tracked in your instance of Bugzilla and then link the Launchpad bug reports to your reports in Bugzilla. For example: if there's an Ubuntu package of your software, look to see if there are any bugs filed against that package that you're also tracking upstream.

== What to do if you can't find suitable bugs in Launchpad ==

If you can't see any suitable bugs already in Launchpad, you can create some test bugs in Launchpad's [[https://staging.launchpad.net|staging environment]].

'''Note:''' The database for staging is reset every day with a fresh copy of Launchpad's live production database. This can have two impacts:

 * your test bugs will disappear from staging within the next 24 hours
 * if you've added your bug tracker to Launchpad's production environment in the past 24 hours, you need to add it manually to staging.
Line 85: Line 111:
To set up a test tokenserver, edit the environment's trac.ini as follows: To set up a test tokenserver, edit the environment's `trac.ini` as follows:
Line 92: Line 118:
Find simple_tokenserver.py in the tarball and run as follows: Find `simple_tokenserver.py` in the tarball and run as follows:
Line 101: Line 127:
Now visit $TRAC_URL/launchpad-auth/abc in your browser, and you should get
an "OK" along with a cookie. Now visit $TRAC_URL/xmlrpc and you should get
a listing of XML-RPC endpoints. If you get a listing but launchpad is not
Now visit `$TRAC_URL/launchpad-auth/abc` in your browser, and you should get
an "OK" along with a cookie. Now visit `$TRAC_URL/xmlrpc` and you should get
a listing of XML-RPC endpoints. If you get a listing but Launchpad is not
Line 105: Line 131:

= Next steps =

Once you've installed the plugin, [[https://answers.edge.launchpad.net/malone|file a question using Launchpad Answers]] to let the Launchapd team know that you're running the plugin. This will allow the Launchpad Bugs developers and sys admins to finish the setup from their end.

~-[[Bugs| < Bug tracker]]-~

Launchpad Help > Bugs > Launchpad-Trac plugin

Overview

Launchpad can communicate directly with bug trackers that use Trac through the trac-launchpad plugin.

If you run a Trac instance, you can use the plugin to:

  • share comment histories between bugs that are tracked both in your Trac tracker and also in Launchpad
  • reduce the server load of bug watches from Launchpad.

To start using the plugin, you need to install it in your Trac environment and also tell Launchpad that you're using the plugin.

Installation

Prerequisites

Before installing the Launchpad plugin for Trac, you need to have the following:

  • Trac 0.10.x or 0.11
  • Setuptools for Python
  • TracXMLRPC Plugin

  • (for Trac 0.11+) Genshi 0.5 or better
  • (for Trac 0.10) a couple of patches to the Trac core (see below).

Getting the plugin

You can download the plugin from its Launchpad project page.

Patching Trac 0.10

If you're using Trac 0.10 you need to apply the patches, provided in the 0.10-patches directory of the trac-launchpad tarball, to your current Trac installation:

$ cd /path/to/trac; patch -p1 < /path/to/trac-launchpad/0.10-patches/*

Systemwide installation

To install the plugin, unpack the tarball to /tmp and run python setup.py install in the unpacked directory:

$ cd /tmp
$ tar zxvf /path/to/trac-launchpad-0.1.2.tgz
$ cd trac-launchpad
$ sudo python setup.py install

Activating the plugin

To activate the plugin in a specific Trac instance, edit $TRAC_ENV/conf/trac.ini and add the following lines:

# for 0.10
[components]
tracrpc.* = enabled
tracext.launchpad.* = enabled

[ticket-custom]
launchpad_bug = text
launchpad_bug.label = Launchpad Bug

You must then grant the special 'launchpad' user permission to access the XML-RPC interface, by executing:

$ trac-admin $TRAC_ENV permission add launchpad XML_RPC
$ trac-admin $TRAC_ENV permission add launchpad LAUNCHPAD_RPC

After restarting your webserver, launchpad should be able to sync bugs. In order to verify whether the plugin was enabled correctly, you can always log in with TRAC_ADMIN privileges and then visit $YOUR_TRAC_URL/plugins if you have version 0.11.

  • Getting Launchpad to work with your bugtracker =

Once the plugin is installed and working you need to register your bugtracker with Launchpad, if it isn't already registered.

This is really simple to do:

Step 1: Visit https://launchpad.net/bugs/bugtrackers

Step 2: Check to see if your bugtracker is registered. If it isn't, click the Register another bugtracker link at the bottom of the page.

Step 3: Enter your bugtracker's details and click the Add button.

Step 4: Your bug tracker should now show up in the list of registered bugtrackers.

Step 5: Look through Launchpad to find bugs that are being tracked in Launchpad that are also tracked in your instance of Bugzilla and then link the Launchpad bug reports to your reports in Bugzilla. For example: if there's an Ubuntu package of your software, look to see if there are any bugs filed against that package that you're also tracking upstream.

What to do if you can't find suitable bugs in Launchpad

If you can't see any suitable bugs already in Launchpad, you can create some test bugs in Launchpad's staging environment.

Note: The database for staging is reset every day with a fresh copy of Launchpad's live production database. This can have two impacts:

  • your test bugs will disappear from staging within the next 24 hours
  • if you've added your bug tracker to Launchpad's production environment in the past 24 hours, you need to add it manually to staging.

Troubleshooting

To set up a test tokenserver, edit the environment's trac.ini as follows:

[launchpad]
auth_server = http://localhost:8081/tokens/%s/+bugtracker-handshake

Find simple_tokenserver.py in the tarball and run as follows:

$ python simple_tokenserver.py +

The plus gives the default policy, which allows all requested tokens to match.

Now visit $TRAC_URL/launchpad-auth/abc in your browser, and you should get an "OK" along with a cookie. Now visit $TRAC_URL/xmlrpc and you should get a listing of XML-RPC endpoints. If you get a listing but Launchpad is not in it, check the permissions for the launchpad user.

Next steps

Once you've installed the plugin, file a question using Launchpad Answers to let the Launchapd team know that you're running the plugin. This will allow the Launchpad Bugs developers and sys admins to finish the setup from their end.

< Bug tracker

Bugs/TracPlugin (last edited 2018-05-30 09:31:46 by cjwatson)