Changes between Version 28 and Version 29 of TracTicketChangelogPlugin


Ignore:
Timestamp:
Apr 4, 2017, 8:48:33 AM (5 years ago)
Author:
Ryan J Ollos
Comment:

Add configuration for version 1.2 of the plugin.

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketChangelogPlugin

    v28 v29  
    77This plugin adds a changelog list in a Trac ticket. You do not need to switch from your coding environment to your browser and your comment ticket anymore to see this changeset.
    88
    9 Just compose your log message following the pattern. The default pattern is add #ticketid before the log messages.
     9Just compose your log message following the pattern. The default pattern in versions 0.12 and 1.0 of the plugin is to add #ticketid before the log messages.
    1010{{{
    1111#ticketid any messages
    1212}}}
    1313
    14 This is done by scanning commit logs for the ticket number which match a configurable regular expression.
     14In version 1.2 of the plugin the [trac:CommitTicketUpdater] options are used
     15to configure the pattern. With the default option, patterns such like `refs #1` and `fixes #2` will be matched.
    1516
    1617Tested with Subversion, Mercurial and Git.
     
    8485[ticketlog]
    8586; optional: custom your log message pattern
    86 log_pattern = ^\s*#%s[:\s]+.*$
     87log_pattern = ^\s*#%s[:\s]+.*$  # version 0.12 and 1.0
    8788; optional: set log message's max length, default is no limit
    8889log_message_maxlength = 100
    8990}}}
     91 1. (Version 1.2) Sync the `ticket-revision` table:
     92{{{#!sh
     93$ trac-admin $env ticketlog sync
     94}}}
     95 You must configure [TracRepositoryAdmin#Repositorycaching repository caching]
     96 and [TracRepositoryAdmin#ExplicitSync explicit synchronization], and `resync`
     97 all of the repositories before running `ticketlog sync`.
    9098
    9199== Configuration
    92100
    93  * You can configure the log_pattern to define your pattern.
    94   * `%s` in the pattern will be replaced with the referenced ticket number (e.g. 12345), so `\s*#%s+\s+.*` will be evaluated as `\s*#12345+\s+.*`.
    95   * `(?:\n|[^#])*#%s(?:\D|$)` matches ticket references in the form `#xyz` anywhere in the commit message.[[br]]See comment:5:ticket:7884
     101In version 0.12 and 1.0 of the plugin you can configure `log_pattern`:
     102* `%s` in the pattern will be replaced with the referenced ticket number (e.g. 12345), so `\s*#%s+\s+.*` will be evaluated as `\s*#12345+\s+.*`.
     103* `(?:\n|[^#])*#%s(?:\D|$)` matches ticket references in the form `#xyz` anywhere in the commit message.[[br]]See comment:5:ticket:7884
     104
     105In version 1.2 of the plugin, the pattern is configured using the
     106[trac:CommitTicketUpdater#Configuration CommitTicketUpdater] options.
    96107
    97108== Recent Changes