wiki:TracTicketChangelogPlugin

Show ticket relative changelogs

Description

This plugin add a changelog list in ticket.

You do not need to switch from your coding environment to browser and comment ticket for this changeset anymore.

Just compose you log message following the pattern, then all done. The default pattern is add #ticketid before the log messages.

#ticketid any messages

This is done by scanning commit logs for ticket number which match a configurable regular expression.

Subversion, mercurial, git are tested.

Mercurial

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

Git

For git backend, according to #7746, you should add following config to git section:

[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 as below.

Bugs/Feature Requests

Existing bugs and feature requests for TracTicketChangelogPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

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

Install

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

  1. Uninstall TracTicketChangelogPlugin if you have installed before.
  2. Change to the directory containning setup.py.
    • (Optional): If you are using Trac 0.12 with i18n, you should compile language files here:
      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 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. Config trac.ini:
    [components]
    ticketlog.* = enabled
    
    [ticketlog]
    ; optional: custom your log message pattern
    log_pattern = \s*#%s[:\s]+.*
    ; optional: set log message's max length, default is no limit
    log_message_maxlength = 100
    

Usage

  • make sure you add TICKETLOG_VIEW permission to users
  • you can config log_pattern to define your 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+.*.

Recent Changes

[14228] by rjollos on 2014-11-01 10:11:23
1.0dev: Implement fine-grained permission checks..Refs #11821.

Granting LOG_VIEW for the ticket realm is equivalent to granting the TICKETLOG_VIEW permission that existed in previous versions of the plugin.

[14227] by rjollos on 2014-11-01 10:10:57
1.0dev: Require LOG_VIEW permission to view the ticket log and remove definition of TICKETLOG_* permssions..Refs #11821.
[14196] by rjollos on 2014-10-10 03:58:47
1.0.0dev: Changed to major/minor/micro version scheme. Major and minor will match the supported Trac version. Micro will define the plugin release number.

Author/Contributors

Author: richard
Maintainer: richard
Contributors: hasienda, jun66j5, rjollos

Last modified 2 months ago Last modified on Sep 26, 2014, 9:50:40 AM

Attachments (1)

Download all attachments as: .zip