Version 12 (modified by mrelbe, 4 years ago) (diff)

Admin commands section added

Ticket Changesets Plugin


The TracTicketChangesetsPlugin hooks into changeset notifications and searches commit messages for ticket references. Referenced tickets are updated with the commit message, and all concerning changesets for a ticket are presented in a separate section on ticket pages, just above the change history section.

The source of this plugin is based on code distributed with Trac 0.12 (tracopt/ticket/ The plugin works with multiple repositories. Language is translated if Babel is installed.

This plugin is not compatible with Trac 0.11 or older versions.

Bugs/Feature Requests

Existing bugs and feature requests for TracTicketChangesetsPlugin are here.

If you have any issues, create a new ticket.


Plugin does not work with not-integer revisons (Mercurial, Git and so on)
Only root may execute trac-admin commands
svnsync breaks log


Support i18n and l10n
Add "reformat" comand to accept parameter style
Branch name added to ticket comment on commit
Support "Fixes #x,y" syntax
Show files and logs of change sets in the ticket
Implement a more verbose mode
Use repository user names when updating tickets
Eclipse MyLyn default Trac commit message format issue
No such changeset exception

The plugin currently does not reformat ticket-commit-messages produced by Trac 0.11 since I am not confident in how those are formatted. Please request this together with examples of old ticket-commit-messages, and I will add that capability to this plugin.


Download the zipped source from here.


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


The related changesets are presented just above the ordinary change history:

When several repositories contains changesets relating to a ticket, the content will gracefully be split into one sub-section for each repository.

The plugin can be configured to present the box as initially collapsed, or hidden completely when no changesets are related to the ticket. Revision ranges can be presented in compact form, for example [420-422] instead of [420] [421] [422].

The macros CommitMessage(repo, rev) and TicketChangesets(ticket) are provided to present a commit message for a given repository and revision, and all changesets that are related to a given ticket.

Console administration commands

Console administration commands are available for retrieving and re-synchronizing ticket-changesets relations, and reformatting existing ticket commit messages.

trac-admin /path/to/env ticket_changesets diff
Examine ticket commit messages before reformat.

Generate a diff-like output for analysis before reformatting. The database will not be changed. Before this operation, you may want to run

trac-admin $ENV repository resync "*"
trac-admin /path/to/env ticket_changesets get [ticketid]
Get a comma-separated list of related revisions (#7267).

List format:

#ticketid: rev/reponame,...

"/reponame" is left out for the default repository.

All tickets related to changesets are listed if ticketid is omitted, one ticket on each line. If no changeset relation exists, "None" is displayed.

trac-admin /path/to/env ticket_changesets reformat (DANGEROUS!)
Reformat ticket commit messages.

Before this operation, you may want to run:

trac-admin $ENV repository resync "*"

and then analyse the output of

trac-admin $ENV ticket_changesets diff
trac-admin /path/to/env ticket_changesets resync
Re-synchronize ticket changesets with all repositories

Relations between tickets and changesets are re-built by examining all commit messages, in all repositories, for ticket references. Ticket comments are neither updated nor added due to new discoveries.

Before this operation, you may want to run:

trac-admin $ENV repository resync "*"

Installation instructions

  1. Enable the plugin by the following in trac.ini:
    ticketchangesets.* = enabled
  2. Add the section [ticket-changesets] to configure the behaviour:
    check_perms = true
    collapsed = false
    commands.close = close closed closes fix fixed fixes
    commands.refs = addresses re refs references see ticket tickets
    compact = true
    hide_when_none = false
    notify = false
    resolution = fixed
    • check_perms: Check that the committer has permission to perform the requested operations on the referenced tickets. This requires that the user names be the same for Trac and repository operations.
    • collapsed: Show section on ticket page as initially collapsed.
    • commands.close: Commands that close tickets, as a space-separated list.
    • commands.refs: Commands that add a reference, as a space-separated list. If set to the special value <ALL>, all tickets referenced by the message will get a reference to the changeset.
    • compact: Make compact presentation of revision ranges, for example [1-3] instead of [1] [2] [3].
    • envelope: Require commands to be enclosed in an envelope. Must be empty or contain two characters. For example, if set to "[]", then commands must be in the form of [closes #4].
    • hide_when_none: Hide section on ticket page when no changesets relates to the ticket.
    • notify: Send ticket change notification when updating a ticket.
    • resolution: The resolution to set to a ticket closed by a commit message.
  3. The Trac environment needs to be upgraded:
    trac-admin /path/to/env upgrade
  4. Re-synchronize repositories (optional, but recommended before next step which will scan all existing commit messages):
    trac-admin /path/to/env repository resync "*"
  5. Build relations between tickets and changesets:
    trac-admin /path/to/env ticket_changesets resync
  6. Re-format existing ticket commit messages (DANGEROUS!)
    1. Produce a diff-like output for your analysis, which does not affect the database, before re-formatting existing commit messages:
      trac-admin /path/to/env ticket_changesets diff > out.diff
      Examine out.diff and assert that re-formatting is sensible before next step.
    2. Re-format (DANGEROUS!)
      trac-admin /path/to/env ticket_changesets reformat
  7. Setup hook-scripts (Windows example, does not differ from official instructions applicable to Trac 0.12):
    1. post-commit.cmd
      :: Trac 0.12 post-commit hook script for Windows
      @SET REPOS=%1
      @SET REV=%2
      @trac-admin /path/to/env changeset added "%REPOS%" "%REV%"
    2. post-revprop-change.cmd
      :: Trac 0.12 post-revprop-change hook script for Windows
      @SET REPOS=%1
      @SET REV=%2
      @trac-admin /path/to/env changeset modified "%REPOS" "%REV%"

From here-on, tickets will be updated when referenced in a commit message, and the relation between tickets and revisions are automatically tracked.

Recent Changes

[10743] by mrelbe on 2011-10-06 21:24:40
Patch supplied by mat (comment:15:ticket:7301)
"working patch, but it's far from being rock-solid"
[10742] by mrelbe on 2011-10-06 21:13:35
Branch trunk to apply patches supplied in #7301
[10004] by mrelbe on 2011-03-31 21:46:08
TracTicketChangesetsPlugin: Fixed a glitch regarding foldable headline of the changesets section on ticket pages.


Are you using TracTicketChangesets plugin?
  • Yes, it's usefull. (mrelbe, dnedelchev)
  • No, it's useless.
  • No, I don't need it.

  • You don't have permission to vote. You may need to login.


Author: mrelbe
Maintainer: mrelbe

Attachments (1)

Download all attachments as: .zip