wiki:TracTicketChangelogPlugin

Version 29 (modified by Ryan J Ollos, 2 years ago) (diff)

Add configuration for version 1.2 of the plugin.

Show ticket relative changelogs

Description

This 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.

Just 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.

#ticketid any messages

In version 1.2 of the plugin the CommitTicketUpdater options are used to configure the pattern. With the default option, patterns such like refs #1 and fixes #2 will be matched.

Tested with Subversion, Mercurial and Git.

Mercurial

For mercurial backend, since TracMecurial does not support repository cache yet, you should install TracMercurialChangesetPlugin to generate the repository cache.

Git

For git backend, according to #7746, you should add following config to git section in the trac.ini file:

[git]
cached_repository = true
persistent_cache = true

You might need to run trac-admin repository resync after the change.

Example

For example, when you commit for ticket #10, the commit log like:

#10 fixed blog

And you got a revision [1234]. After that, when open ticket #10, you can see a change log list:

Bugs/Feature Requests

Existing bugs and feature requests for TracTicketChangelogPlugin are here.

If you have any issues, create a new ticket.

defect

23 / 23

enhancement

6 / 6

task

0 / 1

Download

Download the zipped source from here.

Source

You can check out TracTicketChangelogPlugin from here using Subversion, or browse the source with Trac.

Installation

You can install this plugin following the standard procedures described in TracPlugins.

  1. Uninstall TracTicketChangelogPlugin if you have installed it before.
  2. Change to the directory containning setup.py.
    • (Optional): If you have Babel installed and would like to have translations available:
      python setup.py compile_catalog -f
      
  3. If you want to install this plugin globally, that will install this plugin to the Python path:
    • python setup.py install
  4. If you want to install this plugin to the Trac instance only:
    • python setup.py bdist_egg
    • copy the generated egg file to the trac instance's plugin directory
      cp dist/*.egg /srv/trac/env/plugins
      
  5. Add the following to the trac.ini file in the components section:
    [components]
    ticketlog.* = enabled
    
    [ticketlog]
    ; optional: custom your log message pattern
    log_pattern = ^\s*#%s[:\s]+.*$  # version 0.12 and 1.0
    ; optional: set log message's max length, default is no limit
    log_message_maxlength = 100
    
  6. (Version 1.2) Sync the ticket-revision table:
    $ trac-admin $env ticketlog sync
    
    You must configure repository caching and explicit synchronization, and resync all of the repositories before running ticketlog sync.

Configuration

In version 0.12 and 1.0 of the plugin you can configure log_pattern:

  • %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+.*.
  • (?:\n|[^#])*#%s(?:\D|$) matches ticket references in the form #xyz anywhere in the commit message.
    See comment:5:ticket:7884

In version 1.2 of the plugin, the pattern is configured using the CommitTicketUpdater options.

Recent Changes

17251 by rjollos on 2018-07-30 23:14:06
TracTicketChangelog 1.2.0dev: Don't fail on exception when syncing the repository

Fixes #13461.

16848 by rjollos on 2017-10-05 04:45:12
TracTicketChangelog 1.2.0dev: Require CHANGESET_VIEW

This revises r14227, as CHANGESET_VIEW is more appropriate
than LOG_VIEW.

Refs #11821.

16847 by rjollos on 2017-10-05 04:44:53
TracTicketChangelogPlugin 1.0.1: Require CHANGESET_VIEW

This revises r14227, as CHANGESET_VIEW is more appropriate
than LOG_VIEW.

Refs #11821.

(more)

Author/Contributors

Author: richard
Maintainer: Ryan J Ollos
Contributors: hasienda, jun66j5

Attachments (1)

Download all attachments as: .zip