Version 14 (modified by Rob Guttman, 6 years ago) (diff)


Lightweight code review of changesets

Notice: This plugin is unmaintained and available for adoption.


This plugin adds a lightweight means to review changesets directly on existing changeset pages. (JavaScript is required.)

This plugin comes with its own CommitTicketReferenceMacro which can be optionally used instead of the built-in one to display the current status within the ticket:

When a review summary is provided, it gets added as a comment to all tickets referenced in the changeset (also shown above).

There are other good code review tools out there that I've used (e.g., gerrit) but I wanted something very lightweight that fits well into existing Trac tools and ticket workflow. The few existing Trac-based code review plugins (below) appear to be unmaintained. And so this plugin was born.

See also: CodeReviewPlugin, PeerReviewPlugin, ExoWebCodeReviewPlugin


  1. Install the plugin (after downloading and unzipping):
    cd codereviewerplugin/0.12
    sudo python bdist_egg
    sudo cp dist/TracCodeReviewer*.egg /your/trac/location/plugins/

See TracPlugins for more installation details and options. You'll likely need to restart Trac's web server after installation.

  1. Enable the plugin and if using the built-in commit-updater, disable CommitTicketReferenceMacro:
    tracopt.ticket.commit_updater.committicketupdater = enabled
    tracopt.ticket.commit_updater.committicketreferencemacro = disabled
    coderev.* = enabled

You can alternatively use the Trac Web Admin GUI to enable or disable components.

  1. (optional) Customize the names for the three statuses (make sure there are always exactly three in the shown order of meaning):
    status_choices = REJECTED,PENDING,PASSED
    status_default = PENDING
  1. After the above, run:
    sudo trac-admin /path/to/projenv upgrade

See the examples section below for more configuration options.

Bugs/Feature Requests

Existing bugs and feature requests for CodeReviewerPlugin are here.

If you have any issues, create a new ticket.


Download the zipped source from [download:codereviewerplugin here].


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


The screenshots in the examples above show basic examples. There are some additional extensions:


There are many ways to integrate code reviews into your Trac ticket workflow. As just one example, you may have a phase custom field that includes different phases:

  1. implementation
  2. codereview
  3. verifying

If you wanted to prevent the phase from moving beyond "codereview" until all pending code reviews were completed and the last changeset passed review, then if using this plugin's commit ticket reference macro you can add the following DynamicFields plugin rules:

phase.invalid_if.1 = verifying
phase.invalid_when.1 = .codereviewstatus .pending (msg:Pending code reviews.)
phase.invalid_if.2 = verifying
phase.invalid_when.2 = .codereviewstatus:last .rejected (msg:The last code review did not pass.)



Recent Changes

17016 by jun66j5 on 2017-12-08 03:52:54
CodeReviewerPlugin 1.0.0dev: fix ValueError raising when configuration is invalid (refs #13344)
17015 by jun66j5 on 2017-12-08 03:50:37
CodeReviewerPlugin 1.0.0dev: fix post_process_request crashing when internal error is raised (refs #13344)
17014 by jun66j5 on 2017-12-07 19:15:01
CodeReviewerPlugin 1.0.0dev: fix ProgrammingError raised on PostgreSQL (closes #13343)

Initial patch by ntmlod.



Author: robguttman
Maintainer: robguttman

Attachments (2)

Download all attachments as: .zip