wiki:TracTicketChangesetsPlugin

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

--

Ticket Changesets Plugin

Description

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/commit_updater.py). 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.

Download

Download the zipped source from here.

Source

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

Example

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 are available for resynchronizing relations between tickets and changesets:

  • trac-admin %ENV% ticket_changesets diff
  • trac-admin %ENV% ticket_changesets reformat (DANGEROUS!)
  • trac-admin %ENV% ticket_changesets resync

Please see the in-built documentation for more details.

Installation instructions

  1. Enable the plugin by the following in trac.ini:
    [components]
    ticketchangesets.* = enabled
    
  2. Add the section [ticket-changesets] to configure the behaviour:
    [ticket-changesets]
    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
    
  3. The Trac environment needs to be upgraded:
    trac-admin %ENV% upgrade
    
  4. Re-synchronize repositories (optional, but recommended before next step which will scan all existing commit messages):
    trac-admin %ENV% repository resync "*"
    
  5. Build relations between tickets and changesets:
    trac-admin %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 %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 %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 TRAC_ENV=...
      @SET REPOS=%1
      @SET REV=%2
      @trac-admin "%TRAC_ENV%" changeset added "%REPOS%" "%REV%"
      
    2. post-revprop-change.cmd
      :: Trac 0.12 post-revprop-change hook script for Windows
      ::
      @SET TRAC_ENV=...
      @SET REPOS=%1
      @SET REV=%2
      @trac-admin "%TRAC_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.

Author/Contributors

Author: mrelbe
Maintainer: mrelbe
Contributors:

Attachments (1)

Download all attachments as: .zip