[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

[TSVN] bugtraq feature extension

From: <Nick_Gianakas_at_sybari.com>
Date: 2005-01-10 18:02:14 CET

Where is the (or is there an) appropriate place to discuss the Integration
with Bugtracking System (bugtraq) system?
I think the idea originated here.

I have a feature extension request for the bugtraq system.

The proposal is specified below, and at
http://www.wheeloyum.com/BugtraqExtension.txt

---------------------------------------------------

The following proposal describes an extension to the existing
Integration with Bugtracking Systems as outlined at:
http://tortoisesvn.tigris.org/docs/TortoiseSVN_en/ch04s10.html

The current system presents the user with an entry field where the
issue(s) can be typed. The deficiency with this system is it requires
the user to manually access their issue tracker, locate the issue(s) that
apply, and copy the issue numbers to the commit dialog.

The idea of this extension is to perform all the manual work for the user.
If enabled, it will provide the user with a list of issues to select from
instead of using a manual entry field.

This extension can co-exist with the existing system in cases that an
issue list is not available (or not accessible programatically).

This extension focuses on issue # entry--it uses the existing system for
storage and access. All of the existing bugtraq: properties still apply;
this extension simply adds the ability to select issues from a list.

Some mechanism is required which will obtain and list the issues to be
selected.

1. Add a new bugtraq: property to enable this mode of operation
   Perhaps "bugtraq:presentselectablelist" [true|false]
2. Add a new bugtraq: property to specify the name of the program/script
   to spawn.
   Perhaps "bugtraq:issuelistprovider"
   For maximum flexibility, the spawned entity could be an HTTP URL
   instead of a program/script. Supporting an HTTP URL eliminates the
   need for a locally-accessible program/script. It may also be easier
   to provide the issue list from a URL as many issue trackers have or
   support a web interface.
3. The SVN client will spawn the specified program/URL and provide
   certain input arguments (see "ISSUES" below).
   Input arguments to an HTTP URL can be in the form of
   GET/POST/other headers.
4. The spawned program/script will output a list of issues. For maximum
   flexibility, the output format should be XML. XML will provide
   flexibility in the client (parsing), and allow for differences in
   issue trackers (amount of info available/returned).
   For example, the XML schema could define a full list of possible
   output, but perhaps the issue ID # is the only required piece.
   So if an issue tracker can return other info (project, component,
   subject, etc), it's up to client to display it.
   See "SAMPLE XML FORMAT" below for a very simple/naive XML format.
5. Finally, when the output is received by the client, it can be parsed
   and presented to the user.
   It's important to note that the client can display as much or as
   little of the returned data as desired. For example: It can display
   only a list of issue numbers in a drop-down multi-select list box;
   It can display all available data in a full report list in a
   separate dialog; or it can display anything in betweeen.
   The output data can optionally provide a URL for each issue so the
   client can provide a link for the user to access each issue.
     a) If a button is used to display a list, a new bugtraq: property
        will be needed to define the label for the button.
        Perhaps "bugtraq:listbuttonlabel"
        This property can be set to "Select..." for example.

This system will integrate the SVN client and issue tracker a little
tighter to save the user time.

ISSUES
1. Getting enough information to the input of the program that outputs
   the issue list so it can narrow down the list as much as possible.
     a) As a minimum, a user name should be presented. This migh
        require another bugtraq: property which will generate the
        issue tracker user name from the SVN user name plus some
        decorations.
          ex: bugtraq:issueusername %SVNUSERNAME%@mydomain.com
     b) Possibly some path information
     c) Possibly support other bugtraq: properties which can be
        fed as arguments.
          ex: bugtraq:issueproject, bugtraq:issuecomponent, etc
     d) Optionally support credentials for the issue tracker.

SAMPLE XML FORMAT
The following is a very simple/naive XML format for reference:
<?xml version="1.0" encoding="ISO-8859-1"?>
<issues
   product="My Issue Tracker"
   url="http://my.issue.tracker"
   user="johnsmith"
   bugtraq_format_version="1.0">
      <issue
         id="1"
         date="2005-01-01"
         status="assigned"
         project="common"
         component="logger"
         summary="Broken support for large files"
         url="http://my.issue.tracker/show_bug.cgi?id=1" />
      <issue
         id="2"
         date="2005-01-02"
         status="assigned"
         project="common"
         component="scheduler"
         summary="Broken support for daylight savings time"
         url="http://my.issue.tracker/show_bug.cgi?id=2" />
</issues>

---------------------------------------------------

Regards,
Nick G

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tortoisesvn.tigris.org
For additional commands, e-mail: dev-help@tortoisesvn.tigris.org
Received on Mon Jan 10 18:06:59 2005

This is an archived mail posted to the TortoiseSVN Dev mailing list.