From 7d89b44f6afa34964d56061e2fef1de940bce88d Mon Sep 17 00:00:00 2001 From: vmassol Date: Tue, 20 Apr 2004 19:39:52 +0000 Subject: [PATCH] Added documentation for the format of changes.xml file. git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115025 13f79535-47bb-0310-9956-ffa450edef68 --- changes/xdocs/changes.xml | 5 +- changes/xdocs/index.xml | 101 ++++++++++++++++++++++++++++++++++++-- 2 files changed, 100 insertions(+), 6 deletions(-) diff --git a/changes/xdocs/changes.xml b/changes/xdocs/changes.xml index 1553af6b..dd99746a 100644 --- a/changes/xdocs/changes.xml +++ b/changes/xdocs/changes.xml @@ -24,7 +24,10 @@ Vincent Massol - + + + Added documentation for the format of changes.xml file. + Fix anchor links in report diff --git a/changes/xdocs/index.xml b/changes/xdocs/index.xml index 6f1b5426..3ee97245 100644 --- a/changes/xdocs/index.xml +++ b/changes/xdocs/index.xml @@ -20,16 +20,18 @@ - Maven Changes Plug-in + Maven Changes plugin Vincent Massol -
+

This plugin produces a changes report showing the differences between different releases of the project using it.

+
+

In order to use this plugin, simply create a changes.xml file in your xdocs directory. Here's an example of a @@ -53,20 +55,109 @@ Added blah blah. - + Corrected bug blah blah. - + Removed blah blah. ]]> +

A live Changes example report can be found - here. + here.

+ +

+ The following attributes are supported for the <release> + element: +

+ + + + + + + + + + + + + + + + + +
Attribute nameDescriptionRequired?
version + Name of the version for which to describe the changes. For each + change, add a nested <action> element as + described below. + yes
date + Date at which the version was released. You can use a free form + comment such as "in CVS" for unreleased versions. + yes
+ +

+ The following attributes are supported for the <action> + element: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Attribute nameDescriptionRequired?
dev + Name of developer who committed the change. This must be the name + of the developer as described in the developers + section of the POM (project.xml file). + yes
type + Type of change. There are four valid values: + add, fix, remove, + update. + yes
issue + Id of the issue related to this change. This is the id in your + bug tracking system. The Changes plugin will generate a URL out + of this id. The URL is constructed by using the + maven.changes.issue.template property. See the + page for more details. + no
due-to + Name of the person to be credited for this change. To be used + when a patch is submitted by a non-committer. + no
due-to-email + Email of the person to be credited for this change. + no
+