wiki:TracChecklistMacro

Use wiki pages as checklist templates within tickets

This plugin allows you to define checklists as a wiki page, and then embed them in tickets as templates for recurring tasks. For example, if your workflow for a bug ticket includes steps for fix/test/release, each of these can be defined as a step and checked off as the assignee works on the ticket.

This prevents people from forgetting something (e.g. tag a new version), and allows for ongoing process improvements by updating the checklist whenever gaps in the existing process are discovered.


Installation

A plugin can either be deployed globally, or only for a specific environment. Global deployment is done by installing the plugin:

 $ cd /path/to/pluginsource
 $ python setup.py install

The plugin is also available on PyPI and can be installed globally using pip:

 $ pip install TracChecklist

To deploy a plugin only to a specific Trac environment, copy the egg file into the plugins directory of that environment:

 $ cd /path/to/pluginsource
 $ python setup.py bdist_egg
 $ cp dist/*.egg /path/to/projenv/plugins

Setup

The plugin requires a new database table; update the environment to create it:

 $ trac-admin /path/to/env upgrade 

The plugin uses static resources (CSS, JS). If you mapped static resources so they are served by the web server, the resources need to be deployed to the location on the filesystem that is served by the web server. Execute the deploy command, as is done during install and upgrade:

 $ trac-admin /path/to/env deploy /deploy/path

The plugin creates a wiki:ChecklistTemplates page as the root below which all checklist definitions are located. If you move the page, update the entry in your trac.ini file:

[checklist]
template_root = /path/to/ChecklistTemplates

Restart the server once fully configured.

Use

Create at least one checklist as a sub-page below the wiki:ChecklistTemplates page using the template provided. You can also create pages below non-existing parents, which will then be treated as category headers. For exmaple:

    wiki:ChecklistTemplates
    |- CatOne (not a page)
	   |- wiki:ChecklistTemplates/CatOne/Checklist One
	   |- wiki:ChecklistTemplates/CatOne/Checklist Two
    |- CatTwo (not a page)
	   |- wiki:ChecklistTemplates/CatTwo/Checklist Three
	   |- wiki:ChecklistTemplates/CatTwo/Checklist Four

Then use the dropdown menu at the top-right of any ticket description entry box when in edit mode to select & insert a template. The preview will show the checklist in your ticket.

Revisions

0.1 - Initial upload to PyPI / TracHacks


Bugs/Features

Existing bugs and feature requests for TracChecklistMacro are here.

If you have any issues, create a new ticket.

defect

1 / 1

Download

Download the zipped source from here.

This plugin is also released on PyPi.

Source

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

Recent Changes

18467 by SydRa on 2022-01-30 21:33:35
v0.1.4 - removed egg-info per #14109
18466 by SydRa on 2022-01-30 21:32:05
v0.1.4 - removed egg-info per #14109
18465 by SydRa on 2022-01-28 16:29:02
v0.1.4 - fixes bug #14109
(more)

Author/Contributors

This plugin was developed and is maintained by https://sydereal.space

Author: SydRa
Maintainer: Ralph Ewig
Contributors:

Last modified 8 months ago Last modified on Feb 14, 2022, 5:31:48 AM

Attachments (2)

Download all attachments as: .zip