Changes between Version 3 and Version 4 of TracTicketChangesetsPlugin


Ignore:
Timestamp:
Jun 4, 2010, 9:09:29 AM (14 years ago)
Author:
Mikael Relbe
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketChangesetsPlugin

    v3 v4  
    77The 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.
    88
    9 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.
     9The source of this plugin is based on code provided distributed with Trac 0.12 (tracopt/ticket/commit_updater.py). The plugin works with multiple repositories. Language is translated if Babel is installed.
    1010
    11 Console administration commands are available for resynchronizing relations between tickets and changesets.
    12 
    13 The source of this plugin is based on code provided distributed with Trac 0.12 (tracopt/ticket/commit_updater.py). The plugin works with multiple repositories.
    14 
    15 '''This plugin is not compatible with Trac 0.11'''
     11'''This plugin is not compatible with Trac 0.11 or older versions.'''
    1612
    1713
     
    3733 [[Image(ticket_changesets_box.gif)]]
    3834
    39 The plugin can be configured to present the box as initially collapsed, or hidden completely when no changesets are related to the ticket. Please see the in-built documentation for more details. Revision ranges can be presented in compact form, for example [420-422] instead of [420] [421] [422].
     35When several repositories contains changesets relating to a ticket, the content will gracefully be split into one section for each repository.
    4036
     37The 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].
    4138
    42 === Installation instructions ===
     39The 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.
     40
     41Console administration commands are available for resynchronizing relations between tickets and changesets:
     42 * `trac-admin %ENV% ticket_changesets diff`
     43 * `trac-admin %ENV% ticket_changesets reformat` (DANGEROUS!)
     44 * `trac-admin %ENV% ticket_changesets resync`
     45
     46Please see the in-built documentation for more details.
     47
     48== Installation instructions ==
    4349 1. Enable the plugin by the following in trac.ini:
    4450{{{
     
    6470 1. Re-synchronize repositories (optional, but recommended before next step which will scan all existing commit messages):
    6571{{{
    66 trac-admin $ENV repository resync "*&"
     72trac-admin %ENV% repository resync "*"
    6773}}}
    6874 1. Build relations between tickets and changesets:
    6975{{{
    70 trac-admin $ENV ticket_changesets resync
     76trac-admin %ENV% ticket_changesets resync
    7177}}}
    7278 1. Re-format existing ticket commit messages (DANGEROUS!)
    7379    a. Produce a diff-like output for your analysis, which does not affect the database, before re-formatting existing commit messages:
    7480{{{
    75 trac-admin $ENV ticket_changesets diff > out.diff
     81trac-admin %ENV% ticket_changesets diff > out.diff
    7682}}}
    7783       Examine out.diff and assert that re-formatting is sensible before next step.
    7884    a. Re-format '''(DANGEROUS!)'''
    7985{{{
    80 trac-admin $ENV ticket_changesets reformat
     86trac-admin %ENV% ticket_changesets reformat
    8187}}}
    8288 1. Setup hook-scripts (Windows example, does not differ from official instructions applicable to Trac 0.12):