wiki:ChangeLogMacro

List changelog entries from repository

Description

This plugin displays the changelog for a repository path. As an example, it displays the changes applied to software products as shown in the Recent changes section of this page below.

The ChangeLog macro writes a log of the latest changes of a repository at a given path. Following variants are possible to use:

1. [[ChangeLog(/path)]]
2. [[ChangeLog(/path@rev)]]
3. [[ChangeLog(/path@rev, limit)]]
4. [[ChangeLog(/path@from-to)]]
5. [[ChangeLog(/path, limit, rev)]]
  1. Default repository is used if the reponame is left out. To show the last five changes of the default repository:
    [[ChangeLog(/)]]
    

To show the last five changes of the trunk folder in a named otherrepo:

[[ChangeLog(/otherrepo/trunk)]]
  1. The ending revision can be set. To show the last five changes up to revision 99:
    [[ChangeLog(/otherrepo/trunk@99)]]
    
  1. The maximum amount of changes to display can be set by an optional parameter. To show the last 10 changes, up to revision 99:
    [[ChangeLog(/otherrepo/trunk@99, 10)]]
    
  1. A range of revisions can be logged:
    [[ChangeLog(/otherrepo/trunk@90-99)]]
    

To list all changes:

[[ChangeLog(/otherrepo/trunk@1-HEAD)]]

Note that HEAD can be left out:

[[ChangeLog(/otherrepo/trunk@1-)]]
  1. For backwards compatibility, the revision can be stated as a third parameter:
    [[ChangeLog(/otherrepo/trunk, 10, 99)]]
    

Both limit and rev may be keyword arguments:

[[ChangeLog(/otherrepo/trunk, limit=10, rev=99)]]

Examples:

  1. Display change log for this plugin, back 3 revisions:
[[ChangeLog(/changelogmacro, 3)]]

Results in this:

18148 by Cinc-th on 2021-04-04 17:05:44
ChangeLogMacro: Python 3 fixes for !StringIO and string/bytes handling. Some minimal testing indicates the macro does work with Trac 1.5/Trac 1.6.
17610 by rjollos on 2019-12-03 12:43:50
TracChangeLog 0.6dev: Add classifiers metadata

Version 0.5 has been published to pypi:TracChangeLog/0.5

Fixes #13672.

16913 by rjollos on 2017-10-25 01:49:37
TracChangeLog 0.5dev: Make compatible with Trac 1.3.x and fix "(more)" link

Refs #13313.

(more)

  1. Display change log starting at specific revision:
[[ChangeLog(/changelogmacro, 1, 7471)]]

Results in this:

7471 by rjollos on 2010-01-25 04:06:04
Copied from changelogplugin/0.11
(more)

Bugs/Feature Requests

Existing bugs and feature requests for ChangeLogMacro are here.

If you have any issues, create a new ticket.

defect

13 / 14

enhancement

11 / 15

task

3 / 3

Download

Download the zipped source from here.

The macro is also available on PyPI.

Source

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

The 0.11 branch should be used with Trac 0.11 and 0.12. The trunk currently supports Trac 1.0+.

Installation

General instructions on installing Trac plugins can be found on the TracPlugins page.

Recent Changes

18148 by Cinc-th on 2021-04-04 17:05:44
ChangeLogMacro: Python 3 fixes for !StringIO and string/bytes handling. Some minimal testing indicates the macro does work with Trac 1.5/Trac 1.6.
17610 by rjollos on 2019-12-03 12:43:50
TracChangeLog 0.6dev: Add classifiers metadata

Version 0.5 has been published to pypi:TracChangeLog/0.5

Fixes #13672.

16913 by rjollos on 2017-10-25 01:49:37
TracChangeLog 0.5dev: Make compatible with Trac 1.3.x and fix "(more)" link

Refs #13313.

(more)

Author/Contributors

Author: athomas
Maintainer: Ryan J Ollos
Contributors: mwehr, Andor, watho, theist, mrelbe

Last modified 3 years ago Last modified on Apr 6, 2022, 5:59:31 AM