Changes between Version 11 and Version 12 of MultiProjectCommitTicketUpdaterPlugin


Ignore:
Timestamp:
Mar 9, 2022, 7:09:21 AM (5 months ago)
Author:
figaro
Comment:

Move example to functional description

Legend:

Unmodified
Added
Removed
Modified
  • MultiProjectCommitTicketUpdaterPlugin

    v11 v12  
    88
    99This plugin is based on `commit_ticket_updater` by Edgewall Software.
     10
     11Once you have set up the plugin, you can add comments to tickets using something like this:
     12
     13{{{#!sh
     14svn commit -m "Re my-other-project:#12, #13, changed blah and foo to do this and that. Closes my-project:#10 and #12."
     15}}}
    1016
    1117See also:
     
    4955}}}
    5056
    51 Set the [trac:CommitTicketUpdater#Configure CommitTicketUpdater options]. Additionally, the `[ticket]` `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).
     57== Configuration
    5258
     59Set 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:
     60{{{#!ini
     61[ticket]
     62commit_ticket_update_short_name = project-token
     63}}}
    5364
    54 === Caveats
    55 
     65There are some additional configuration considerations post installation of this plugin:
    5666* 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.
    57 
    5867* 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.
    59 
    60 == Example
    61 
    62 Once you have set up the plugin, you can add comments to tickets using something like this:
    63 
    64 {{{#!sh
    65 svn commit -m "Re my-other-project:#12, #13, changed blah and foo to do this and that. Closes my-project:#10 and #12."
    66 }}}
    6768
    6869== Recent Changes