Changes between Version 1 and Version 2 of MultiProjectCommitTicketUpdaterPlugin


Ignore:
Timestamp:
Apr 5, 2012 10:53:21 AM (3 years ago)
Author:
fleeblewidget
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • MultiProjectCommitTicketUpdaterPlugin

    v1 v2  
    66 
    77This plugin is useful if you have multiple Trac projects sharing a repository. By prepending the project name to the ticket number in the approved InterTrac fashion, you can add comments to tickets in specific projects only. 
     8 
     9== Configuration == 
     10 
     11=== Install === 
     12In the usual way: 
     13 
     14{{{ 
     15sudo easy_install 0.12/ 
     16}}} 
     17 
     18=== Enable the plugin === 
     19In the components section of trac.ini: 
     20 
     21{{{ 
     22[components] 
     23multicommitupdater.* = enabled 
     24}}} 
     25 
     26 
     27=== Set options === 
     28 
     29{{{ 
     30[multicommitupdater] 
     31envelope = {} 
     32commands.close = fix fixes fixed-forever 
     33commands.refs = re see rel 
     34}}} 
     35 
     36Where 
     37 * `envelope` (either blank or two characters) specifies a pair of characters which must enclose all commit messages, or none if left blank. '''Default: blank'''. 
     38 * `commands.close` is a space separated list of commands which can be used to close tickets. '''Default: close closed closes fix fixed fixes''' 
     39 * `commands.refs` is a space separated list of commands which can be used to reference tickets. '''Default: addresses re references refs see''' 
     40 
     41=== Gotchas === 
     42 
     43* You must set up a repository hook in order for this plugin to work, in the same way as for the inbuilt commit ticket updater tool. See trac:TracRepositoryAdmin#ExplicitSync for more details. 
     44 
     45* The plugin must be enabled in every project which will be using it. The simplest way to do this is with a shared global configuration file (see trac:TracIni#GlobalConfiguration). 
    846 
    947== Bugs/Feature Requests ==  
     
    2563== Example == 
    2664 
    27 svn commit -m "Re my-other-project:#12, changed blah and foo to do this and that. Closes my-project:#10 and #12." 
     65Once you've set up the plugin, you can add comments to tickets using something like this: 
     66 
     67{{{ 
     68svn commit -m "Re my-other-project:#12, #13, changed blah and foo to do this and that. Closes my-project:#10 and #12." 
     69}}} 
    2870 
    2971== Recent Changes == 
     
    3577'''Author:''' [wiki:fleeblewidget] [[BR]] 
    3678'''Maintainer:''' [wiki:fleeblewidget] [[BR]] 
    37 '''Contributors:''' 
     79'''Acknowledgements:''' based on commit_ticket_updater, copyright Edgewall Software