wiki:TracChangeFileBiffPlugin

Provides a feature like Biff for file in repository

Description

This plugin provides a feature like Biff for file in repository, a mail notification system for UNIX. TracChangeFileBiffPlugin is useful to query or monitor certain files in the repository when someone updates it.

Note: TracChangeFileBiffPlugin requires Trac 1.0 or higher, since it uses the list format of text type. See TracTicketsCustomFields.

Bugs/Feature Requests

Existing bugs and feature requests for TracChangeFileBiffPlugin are here.

If you have any issues, create a new ticket.

Download

Download the archived source from here.

Source

You can clone TracChangeFileBiffPlugin from here using Mercurial, or browse the source.

Configuration

  1. Enable TracChangeFileBiffPlugin in the Plugins page of the web administration menu.
  2. Access to File Biff admin panel: The option of ticket-custom section would be added when you access to File Biff admin page like this:
[ticket-custom]
filebiff = text
filebiff.format = list
filebiff.label = Biff       ; change file label as you like
filebiff.multiple = true    ; this option is used by TracMultiSelectBoxPlugin
filebiff.options =          ; will be set when you configure File Biff settings
filebiff.size = 3           ; this option is used by TracMultiSelectBoxPlugin
filebiff.matching_pattern = fnmatch ; glob matching pattern (fnmatch or gitignore)
  1. Configure File Biff settings:

Specification:

  • White-space is not allowed in the Name.
  • Cc and Filename are configured as multiple values separated by comma.
  • The glob pattern for Filename is allowed.
  • The glob pattern is configurable in filebiff.matching_pattern of [ticket-custom]. The possible values are:

Add a [changefilebiff] section after you configured File Biff settings like this:

[changefilebiff]
biff.2e320ca20d1aed6a.cc = user1
biff.2e320ca20d1aed6a.filename = *.txt, *.text
biff.2e320ca20d1aed6a.name = text-files
biff.319ddde3cb437ffc.cc = user2, guest1
biff.319ddde3cb437ffc.filename = *.properties
biff.319ddde3cb437ffc.name = property-files
biff.dd487b83e5e76d08.cc = user1, user2
biff.dd487b83e5e76d08.filename = *.gif, *.png, *.jpg
biff.dd487b83e5e76d08.name = Image-files
biff_keys = dd487b83e5e76d08, 319ddde3cb437ffc, 2e320ca20d1aed6a

Example

Set Biff value automatically when a user committed into the repository:

The ticket thread then shows the subsequent Biff values:

Operation Tips

Integrate TracMultiSelectBoxPlugin

To integrate TracMultiSelectBoxPlugin is good practice for ticket maintenance like this:

Recent Changes

See https://bitbucket.org/t2y/trac.plugins.changefilebiff/commits.

Author/Contributors

Author: t2y
Maintainer: t2y
Contributors:

Last modified 12 days ago Last modified on Jul 16, 2016, 11:46:33 AM

Attachments (4)

Download all attachments as: .zip