Changes between Version 1 and Version 2 of MultiProjectCommitTicketUpdaterPlugin

Timestamp:

Apr 5, 2012, 8:53:21 AM (12 years ago)

Author:

Ruth Trevor-Allen

Comment:

--

MultiProjectCommitTicketUpdaterPlugin

@@ -6 +6 @@
 
 This 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.
+
+== Configuration ==
+
+=== Install ===
+In the usual way:
+
+{{{
+sudo easy_install 0.12/
+}}}
+
+=== Enable the plugin ===
+In the components section of trac.ini:
+
+{{{
+[components]
+multicommitupdater.* = enabled
+}}}
+
+
+=== Set options ===
+
+{{{
+[multicommitupdater]
+envelope = {}
+commands.close = fix fixes fixed-forever
+commands.refs = re see rel
+}}}
+
+Where
+ * `envelope` (either blank or two characters) specifies a pair of characters which must enclose all commit messages, or none if left blank. '''Default: blank'''.
+ * `commands.close` is a space separated list of commands which can be used to close tickets. '''Default: close closed closes fix fixed fixes'''
+ * `commands.refs` is a space separated list of commands which can be used to reference tickets. '''Default: addresses re references refs see'''
+
+=== Gotchas ===
+
+* 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.
+
+* 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).
 
 == Bugs/Feature Requests == 
@@ -25 +63 @@
 == Example ==
 
-svn commit -m "Re my-other-project:#12, changed blah and foo to do this and that. Closes my-project:#10 and #12."
+Once you've set up the plugin, you can add comments to tickets using something like this:
+
+{{{
+svn commit -m "Re my-other-project:#12, #13, changed blah and foo to do this and that. Closes my-project:#10 and #12."
+}}}
 
 == Recent Changes ==
@@ -35 +77 @@
 '''Author:''' [wiki:fleeblewidget] [[BR]]
 '''Maintainer:''' [wiki:fleeblewidget] [[BR]]
-'''Contributors:'''
+'''Acknowledgements:''' based on commit_ticket_updater, copyright Edgewall Software