wiki:ExtendedVersionPlugin

Version 19 (modified by rjollos, 6 months ago) (diff)

Added contributor.

Extended Version Plugin

Description

The Trac ticket module has the concept of a version, but it is only visible as a name in a drop-down on a ticket. This plugin adds version description pages, a roadmap-like view of versions, and the ability to assign milestones to versions. Most features are optional. This plugin is for Trac 0.12 and later.

  • The version page shows the name, date, description and any assigned milestones. If milestones are assigned, it shows the overall progress for the version and the progress on each milestone.

Development status

There is on-going work to provide similar features in the Trac core. See trac:#1233 and trac:#11409.

  • The version roadmap looks very similar to the milestone roadmap.

  • Milestones assigned to versions have the version noted beside the due date.

Bugs/Feature Requests

Existing bugs and feature requests for ExtendedVersionPlugin are here.

If you have any issues, create a new ticket.

Installation & Configuration

Download

Download the zipped source from here.

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

Installation

The easiest way to install the ExtendedVersionPlugin is probably with easy_install:

easy_install http://trac-hacks.org/svn/extendedversionplugin/trunk

Alternatively, download the source and run the usual

python setup.py install

After installing the plugin, enable it for the trac environment in the TracIni file:

[components]
extendedversion.* = enabled

This plugin requires some database changes, so upgrade the environment. Trac will prompt you to if you don't.

trac-admin /path/to/trac upgrade

Configuration

The ExtendedVersionPlugin has several configuration options available in the [extended_version] section of TracIni. The default values are:

[extended_version]
# component to use to provide group ticket statistics for versions
version_stats_provider = DefaultTicketGroupStatsProvider
# component to use to provide group ticket statistics for milestones in version page
milestone_stats_provider = DefaultTicketGroupStatsProvider
# whether to show milestone description for version pages
show_milestone_description = false

The default configuration adds a Versions item to the main navigation bar. To instead change the Roadmap item to link to the versions page, set the roadmap_navigation to true.

The roadmap_navigation option has been removed in r13314. The equivalent of roadmap_navigation = true can be obtained by setting trac.ticket.roadmap.RoadmapModule = disabled. Prior to r13314, the following option is available:

# whether to replace the roadmap navigation link or add a versions navigation link
roadmap_navigation = false

Recent Changes

[14092] by rjollos on 2014-08-16 19:22:55
Copied branches/0.12 to trunk.
[14091] by rjollos on 2014-08-16 19:21:49
Moved trunk to branches/0.12.
[14090] by rjollos on 2014-08-16 19:19:46
Added branches directory.

Author/Contributors

Author: mestudd
Maintainer: rjollos
Contributors: dcernea, jun66j5
License: BSD 3-Clause

Attachments (3)

Download all attachments as: .zip