Anonymous user
Maintaining the OpenHatch bug tracker: Difference between revisions
Maintaining the OpenHatch bug tracker (view source)
Revision as of 18:50, 26 February 2012
, 12 years ago→Public code
(Created page with 'Imagine giving this document to a version of you, ''just after'' you got shell access to the roundup instance. == What is Roundup, and what should I know about how it is configu…') |
imported>Paulproteus |
||
| (10 intermediate revisions by 2 users not shown) | |||
Line 1:
{{Hacking OpenHatch}}
== What is Roundup? ==
Roundup is the issue-tracking system that we use. If you are looking to file a bug, you should go to the web interface [https://openhatch.org/bugs/ here].
== Who can edit the OpenHatch bug tracker? ==
* Asheesh Laroia and Jack Grigg and Jessica McKellar have Admin status on the web interface and shell access to the tracker.
== How do I access the server backend? ==
Shell access to the Roundup tracker is via the user ''roundup'', and SSH keys are used for authentication. You will need to have been given shell access (i.e. your SSH public key will need to have been added to the list of allowed keys for authenticating as ''roundup''). Once your private key is somewhere that SSH can access it (for GNU/Linux users this is usually the .ssh folder in your home directory), you can log into the server:
<pre>
ssh roundup@linode.openhatch.org
</pre>
===
You will start in the home directory of the user ''roundup'', which is at
<pre>/var/lib/roundup</pre>
The Roundup tracker that we all know and love is kept in the folder
<pre>trackers/bugs/</pre>
(the folder "trackers/issues/" contains an old unused Roundup instance that is kept for archive's sake). The layout of the tracker is described [http://roundup.sourceforge.net/docs/customizing.html#trackers-in-a-nutshell here].
== How do
We won't go through every single feature of Roundup here - that is better left to the [http://roundup.sourceforge.net/docs.html Roundup docs] - but there are a few common things that you may need to do.
=== Add or change a status ===
There are several parts to doing this:
* Adding the new status to the database
** This requires having Admin status for your username on the tracker. Edit the [https://openhatch.org/bugs/status list of statuses], either adding your new status at the end or changing an existing status.
*** Any new status will need to have an ''id'' one greater than the largest current ''id''. (This means don't try use an ''id'' of 7, I don't know where that one went but Roundup has already reserved it.)
*** The 'order' is used to sort the statuses in lists such as on the issue or search pages. You can have fractional values if needed to insert a status between other ones.
* Editing the templates
** You will only need to do this if your status is a 'not-resolved' type of status (which is very likely). These edits change the default views and some links so that issues with your status are displayed at the right times. Look for the string of comma-separated numbers (there is one line in each file), and append the ''id'' of your status to these strings. The following files will need attention (line numbers could be incorrect depending on what other changes have been made):
*** <pre>html/home.html (line 10)</pre>
*** <pre>html/issue.search.html (lines 137 and 138)</pre>
*** <pre>html/page.html (line 24)</pre>
=== Change the people added by default to the nosy list ===
The list of people added by default to the nosy list, and the code responsible for adding them, is kept here:
<pre>detectors/nosyreaction.py</pre>
Edit this file, adding or removing usernames from the list at the top as required.
=== Restarting Roundup ===
Once your changes are complete, you will need to restart Roundup so that it picks up your changes:
<pre>
sudo /etc/init.d/roundup restart
</pre>
'''Note''': This will work for anyone logged in as the Roundup user, because sudo has been configured to allow it.
== Public code ==
* '''Templates, etc.''': Every hour, a cron job wakes up and pushes the Roundup configuration to Gitorious. https://github.com/openhatch/oh-roundup .
* '''Authentication integration''': http://git.jackgrigg.com/django-roundup-authentication/
| |||