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

= Multi-project version of the inbuilt commit_ticket_updater tool

== Description

This plugin allows you to add comments to tickets in an environment with multiple Trac projects sharing one 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.

This plugin is based on `commit_ticket_updater` by Edgewall Software.

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."
}}}

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 [export:multiprojectcommitticketupdaterplugin here].

== Source

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

== Installation

For the 0.12 version of this plugin, see MultiProjectCommitTicketUpdaterPlugin@9.

Install this plugin in the usual way:

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

In the components section of your `trac.ini` file, add the following:
{{{#!ini
[components]
multicommitupdater.* = enabled
tracopt.ticket.commit_updater.committicketreferencemacro = enabled
tracopt.ticket.commit_updater.committicketupdater = disabled
}}}

== Configuration

Set the [trac:CommitTicketUpdater#Configure CommitTicketUpdater options]. Additionally, the `commit_ticket_update_short_name` should be set to the token that you wish to use when referencing tickets. The value defaults to the environment name, i.e. the name of the environment directory:
{{{#!ini
[ticket]
commit_ticket_update_short_name = project-token
}}}

There are some additional configuration considerations post installation of this plugin:
* You must set up a repository hook 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.

== Recent Changes

[[ChangeLog(multiprojectcommitticketupdaterplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:fleeblewidget] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''