home *** CD-ROM | disk | FTP | other *** search
/ Chip 2005 May / CMCD0505.ISO / Software / Shareware / Programare / bugzero / WEB-INF / misc / email / README.txt < prev   
Encoding:
Text File  |  2003-12-08  |  3.3 KB  |  78 lines
  1.            Bugzero Inbound Email Management and CVS/Perforce Integration
  2.  
  3.  
  4. Bugzero accepts issue/bug reports submitted through email.
  5.  
  6.  
  7. Use cases:
  8. ---------
  9.  
  10. 1. Submit updates for multiple existing bugs in one email: 
  11.    (in cases such as source control system integration) 
  12.    Bug # must be given inside the email body in the following format:
  13.    bug: id1, id2, id3  $state
  14.    here, $state is optional, if present, it should be replaced by closed, fixed etc.
  15.    Note that, only Bugzero users or the original submitter can update an existing
  16.    bug.
  17.  
  18. 2. Submit updates for a single existing bug:
  19.    (in cases such as customer replying to email notification from Bugzero)
  20.    Bug # can be given either in the email subject line, or in the email
  21.    body. If one replies to the email notification, the bug # in the link
  22.    (issueId=) will be picked up.
  23.  
  24. 3. Submit a new bug:
  25.    (in cases such as customer sending tech support email request)
  26.    If no bug # is found, or the given bug does not exist, a new bug is created.
  27.    To prevent an email to be saved to the system, you can filter email based
  28.    on mail header Received and From, the Subject, and the email content itself.
  29.    The email filter is applied only to new bug submission.
  30.  
  31. In all cases, one can give a value to any field in the email in a format of:
  32.    $field_internal_name$=value
  33.  
  34. If no value is given to a required field, the default is given to it if the
  35. bug is new. Otherwise, for an existing bug, the field value is not updated.
  36. The email body is always saved in the description/response field.
  37.  
  38. Any attachment to the email is saved as an attachment as it is.
  39.  
  40.  
  41.  
  42. How to setup:
  43. ------------
  44. Bugzero provides two ways to accept incoming emails. The preferred method is to
  45. use the perl script on Linux (see README-linux.txt). On Windows, however, you
  46. need use the build-in mailbox daemon (see README-win.txt).
  47.  
  48.  
  49.  
  50. Steps to setup CVS with Bugzero:
  51. -------------------------------
  52. 1. Modify CVSROOT/loginfo to send email to mailbox_projectx@your-mail-server.com
  53. 2. When commit changes, add the following line in the message:
  54.    bug: 1,2,3 fixed  <-- bug state (add an empty space after the bug numbers)
  55. 3. Since any loginfo emails without a bug number should not be saved into the 
  56.    Bugzero system, you should configure the filters to filter out those emails.
  57. 4. Note that, username and email address must be matched to a Bugzero user.
  58.  
  59. Steps to setup Perforce with Bugzero:
  60. ------------------------------------
  61. 1. On the p4 server, run the Change Review Daemon.
  62. 2. Create a new p4 user for each project you want receive email. The user email 
  63.    address should be the project email, mailbox_projectx@your-mail-server.com,
  64.    and the Review should be dir/files of which changes need to be monitered,
  65.    such as //depot/projectx/...
  66. 3. When a p4 user commits changes, add the following line in the message:
  67.    bug: 1,2,3 fixed  <-- bug state (add an empty space after the bug numbers)
  68. 4. Since any p4 emails without a bug number should not be saved into the 
  69.    Bugzero system, you should configure the filters to filter out those emails.
  70.  
  71.  
  72. Other Source Control System Integration
  73. ---------------------------------------
  74. You may try integrate Bugzero with other version control systems. You need find
  75. out the email trigger your system has and make it send email to
  76. mailbox_projectx@your-mail-server.com, the mailbox or alias that you setup
  77. for incoming emails.   
  78.