[[PageOutline(2-5,Contents,pullout)]]

= Multi-project version of the inbuilt commit_ticket_updater tool

== Description

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.

See also:
 * InterTracCommitPatch provides similar functionality.
 * CustomTicketPrefixPlugin for proper link decoration  of prefixed ticket links.

== Bugs/Feature Requests

Existing bugs and feature requests for MultiProjectCommitTicketUpdaterPlugin are 
[report:9?COMPONENT=MultiProjectCommitTicketUpdaterPlugin here].

If you have any issues, create a 
[/newticket?component=MultiProjectCommitTicketUpdaterPlugin new ticket].

[[TicketQuery(component=MultiProjectCommitTicketUpdaterPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [download:multiprojectcommitticketupdaterplugin here].

== Source

You can check out MultiProjectCommitTicketUpdaterPlugin from [http://trac-hacks.org/svn/multiprojectcommitticketupdaterplugin here] using Subversion, or [source:multiprojectcommitticketupdaterplugin browse the source] with Trac.

== Installation

Install this plugin in the usual way:

{{{#!sh
$ sudo easy_install 0.12/
}}}

In the components section of your `trac.ini` file, add the following information:
{{{#!ini
[components]
multicommitupdater.* = enabled
}}}

Set the following options:

{{{#!ini
[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'''

=== Caveats

* 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).

== Example

Once you have set up the plugin, you can add comments to tickets using something like this:

{{{#!sh
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

[[ChangeLog(multiprojectcommitticketupdaterplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:fleeblewidget] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Acknowledgements:''' based on commit_ticket_updater, copyright Edgewall Software