Author: dennisl
Date: Sun Feb 10 13:33:14 2008
New Revision: 620334
URL: http://svn.apache.org/viewvc?rev=620334&view=rev
Log:
o Improve the documentation.
Added:
maven/plugins/trunk/maven-changes-plugin/src/site/apt/changes.apt (with
props)
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/customizing-jira-report.apt
(with props)
Modified:
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/alternate-changes-xml-location.apt
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/smtp-authentication.apt
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/specifying-mail-sender.apt
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/using-a-custom-announcement-template.apt
maven/plugins/trunk/maven-changes-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-changes-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-changes-plugin/src/site/site.xml
Added: maven/plugins/trunk/maven-changes-plugin/src/site/apt/changes.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/site/apt/changes.apt?rev=620334&view=auto
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/site/apt/changes.apt (added)
+++ maven/plugins/trunk/maven-changes-plugin/src/site/apt/changes.apt Sun Feb
10 13:33:14 2008
@@ -0,0 +1,84 @@
+ ------
+ Changes Reference
+ ------
+ Dennis Lundberg
+ ------
+ 2008-02-10
+ ------
+
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you under the Apache License, Version 2.0 (the
+ ~~ "License"); you may not use this file except in compliance
+ ~~ with the License. You may obtain a copy of the License at
+ ~~
+ ~~ http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing,
+ ~~ software distributed under the License is distributed on an
+ ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~~ KIND, either express or implied. See the License for the
+ ~~ specific language governing permissions and limitations
+ ~~ under the License.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
+
+
+Changes Reference
+
+ This is the reference documentation for the <<<changes.xml>>> file. Here you
+ can find out more about the different attributes that are available for the
+ <<<\<release\>>>> and <<<\<action\>>>> elements.
+
++-----------------+
+<document>
+ <properties>
+ <title/>
+ <author email=.../>
+ </properties>
+ <body>
+ <release date=... version=... description=...>
+ <action dev=... type=... due-to=... due-to-email=... issue=.../>
+ </release>
+ </body>
+</document>
++-----------------+
+
+
+* release
+
+ The following attributes are supported for the <<<\<release\>>>> element:
+
+*--------------------+--------------*------------------------------------------------------------------------------------------+
+<<Attribute>> | <<Optional>> | <<Description>>
+*--------------------+--------------*------------------------------------------------------------------------------------------+
+date | Required | Date at which the version was released.
You can use a free form comment such as "in SVN" for unreleased versions.
+*--------------------+--------------*------------------------------------------------------------------------------------------+
+version | Required | Name of the version in which the
changes occur. For each change, add a nested <<<\<action\>>>> element as
described below.
+*--------------------+--------------*------------------------------------------------------------------------------------------+
+description | Optional | An optional description of the release.
This is used in the overview table of releases. <<Note:>> In releases prior to
2.0-beta-2 this was called <<<desc>>>. It was changed to improve compatibility
with the Maven 1 changes plugin.
+*--------------------+--------------*------------------------------------------------------------------------------------------+
+
+
+* action
+
+ The following attributes are supported for the <<<\<action\>>>> element:
+
+*--------------------+--------------*------------------------------------------------------------------------------------------+
+<<Attribute>> | <<Optional>> | <<Description>>
+*--------------------+--------------*------------------------------------------------------------------------------------------+
+dev | Required | Name of developer who committed the
change. This must be the name of the developer as described in the developers
section of the <<<pom.xml>>> file.
+*--------------------+--------------*------------------------------------------------------------------------------------------+
+type | Required | Type of change. There are four valid
values: <add>, <fix>, <remove>, <update>.
+*--------------------+--------------*------------------------------------------------------------------------------------------+
+due-to | Optional | Name of the person to be credited for
this change. This can be used when a patch is submitted by a non-committer.
+*--------------------+--------------*------------------------------------------------------------------------------------------+
+due-to-email | Optional | Email of the person to be credited for
this change.
+*--------------------+--------------*------------------------------------------------------------------------------------------+
+issue | Optional | Id of the issue related to this change.
This is the id in your issue tracking system.
+ | | The Changes plugin will generate a URL
out of this id. The URL is constructed using the value of the
<<<issueLinkTemplate>>> parameter. See the
{{{changes-report-mojo.html}changes-report mojo}} for more details.
+*--------------------+--------------*------------------------------------------------------------------------------------------+
+
Propchange: maven/plugins/trunk/maven-changes-plugin/src/site/apt/changes.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-changes-plugin/src/site/apt/changes.apt
------------------------------------------------------------------------------
svn:keywords = Date Id
Modified:
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/alternate-changes-xml-location.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/alternate-changes-xml-location.apt?rev=620334&r1=620333&r2=620334&view=diff
==============================================================================
---
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/alternate-changes-xml-location.apt
(original)
+++
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/alternate-changes-xml-location.apt
Sun Feb 10 13:33:14 2008
@@ -24,18 +24,22 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
-Alternate Location for the changes.xml File
+Alternate Location for the <<<changes.xml>>> File
<<Note:>> This feature was introduced in version <2.0-beta-2> of the Changes
plugin.
- If you want to have your <<<changes.xml>>> in another location than the
- default <<<${basedir}/src/changes/changes.xml>>> you can do this by
- configuring your <<<pom.xml>>>. In this example we want to use the file
- <<<${basedir}/src/site/changes.xml>>>:
+ <<Note:>> Unless you have a specific reason to have your <<<changes.xml>>>
+ file in a different location, we advice you to put it in the default location
+ <<<$\{basedir\}/src/changes/changes.xml>>>. If nothing else, it saves you from
+ having to configure it.
+
+ If you <really> want to have your <<<changes.xml>>> in another location than
+ the default location, you can do this by configuring your <<<pom.xml>>>. In
+ this example we want to use the file <<<$\{basedir\}/src/site/changes.xml>>>:
+-----------------+
<project>
Added:
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/customizing-jira-report.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/customizing-jira-report.apt?rev=620334&view=auto
==============================================================================
---
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/customizing-jira-report.apt
(added)
+++
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/customizing-jira-report.apt
Sun Feb 10 13:33:14 2008
@@ -0,0 +1,203 @@
+ ------
+ Customizing the JIRA Report
+ ------
+ Dennis Lundberg
+ ------
+ 2008-02-10
+ ------
+
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you under the Apache License, Version 2.0 (the
+ ~~ "License"); you may not use this file except in compliance
+ ~~ with the License. You may obtain a copy of the License at
+ ~~
+ ~~ http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing,
+ ~~ software distributed under the License is distributed on an
+ ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~~ KIND, either express or implied. See the License for the
+ ~~ specific language governing permissions and limitations
+ ~~ under the License.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
+
+
+Customizing the JIRA Report
+
+ <<Note:>> Most of the features used in this document was introduced in version
+ <<2.0>> of the Changes Plugin. See the
+ {{{../jira-report-mojo.html}goal documentation}} for detailed info on which
+ feature was added in which version.
+
+
+* Selecting version(s)
+
+ We'll start off by creating a JIRA Report for one or more versions of your
+ project. There are two ways to do this.
+
+** Using fix version id(s)
+
+ This is the manual way of doing it. You specify one or more fix version ids,
+ separated by commas. The version ids are usually five digit numbers, but that
+ depends on your JIRA installation.
+
+ The good thing about this method is that you can specify exactly which
+ versions you want, but you have to remember to update your configuration for
+ every new release that you want to include in the report.
+
++-----------------+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changes-plugin</artifactId>
+ <configuration>
+ <fixVersionIds>13722,12515</fixVersionIds>
+ </configuration>
+ ...
+ </plugin>
+ </plugins>
+ </reporting>
+ ...
+</project>
++-----------------+
+
+** Using the current version
+
+ If you are lazy and only ever want the latest release in you JIRA Report, you
+ can use the <<<\<onlyCurrentVersion\>>>> configuration parameter. It will take
+ the version from your project's POM and try to match it against the "Fix for"
+ version of the JIRA issues.
+
+ Once you have configured this, you can forget about it, as it updates itself
+ when you change the version number in your POM.
+
+ <<Note:>> The names of your versions in JIRA must match the ones you use in
+ your POM. The <-SNAPSHOT> part of the version in your POM is handled
+ automatically by the plugin, so you don't need to include <-SNAPSHOT> in the
+ names of your versions in JIRA.
+
++-----------------+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changes-plugin</artifactId>
+ <configuration>
+ <onlyCurrentVersion>true</onlyCurrentVersion>
+ </configuration>
+ ...
+ </plugin>
+ </plugins>
+ </reporting>
+ ...
+</project>
++-----------------+
+
+
+* Selecting columns
+
+ If you are a fan of the Issue Navigator in JIRA, you are going to love this.
+ You can select which columns to include in the report and also specify in
+ which way the issues are sorted.
+
+ In this example we have selected a couple of extra columns, that are not
+ included by default. We want the issues sorted by <<<Type>>> first and by
+ <<<Key>>> secondly. The keys will be sorted in descending order thanks to the
+ <<<DESC>>> marker. Normally they are sorted in ascending order.
+
++-----------------+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changes-plugin</artifactId>
+ <configuration>
+ <columnNames>Type,Key,Summary,Assignee,Status,Resolution,Fix
Version</columnNames>
+ <sortColumnNames>Type,Key DESC</sortColumnNames>
+ </configuration>
+ ...
+ </plugin>
+ </plugins>
+ </reporting>
+ ...
+</project>
++-----------------+
+
+
+* Filtering issues
+
+ Is your report filled with issues that you don't want to publicise? Does it
+ contain duplicate issues and stuff that you decided not to fix? Then this part
+ is for you.
+
+** Using Maven syntax
+
+ In the following example we are only including issues that have <Closed> as
+ their resolution. The status must be either <Resolved> or <Closed>. Only
+ issues with one of the types <Bug>, <New Feature>, <Improvement> or <Wish> are
+ included in the report.
+
++-----------------+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changes-plugin</artifactId>
+ <configuration>
+ <resolutionIds>Closed</resolutionIds>
+ <statusIds>Resolved, Closed</statusIds>
+ <typeIds>Bug, New Feature, Improvement, Wish</typeIds>
+ </configuration>
+ ...
+ </plugin>
+ </plugins>
+ </reporting>
+ ...
+</project>
++-----------------+
+
+ You can also filter by <<<\<component\>>>> and <<<\<priorityIds\>>>>. See the
+ {{{../jira-report-mojo.html}goal documentation}} for info on how to use them.
+
+** Using JIRA syntax
+
+ Another way to filter and sort issues is to configure the plugin using a JIRA
+ syntaxed filter. You can grab this from the URL if you filter and sort issues
+ in the Issue Navigator in JIRA. Just remember that you have to excape the
+ ampersand (&) characters, when you put them into the xml based POM.
+
+ In this example we are filtering out issues with <Fixed> as resolution and
+ sorting them by <type>, in ascending order.
+
++-----------------+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changes-plugin</artifactId>
+ <configuration>
+
<filter>resolution=1&sorter/field=issuetype&sorter/order=ASC</filter>
+ </configuration>
+ ...
+ </plugin>
+ </plugins>
+ </reporting>
+ ...
+</project>
++-----------------+
Propchange:
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/customizing-jira-report.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/customizing-jira-report.apt
------------------------------------------------------------------------------
svn:keywords = Date Id
Modified:
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/smtp-authentication.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/smtp-authentication.apt?rev=620334&r1=620333&r2=620334&view=diff
==============================================================================
---
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/smtp-authentication.apt
(original)
+++
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/smtp-authentication.apt
Sun Feb 10 13:33:14 2008
@@ -24,13 +24,14 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
SMTP Authentication
- If the SMTP host needs authentication, you can provide your username and
password
- in the <<<\<configuration\>>>> section:
+ If the SMTP host needs authentication, you can provide your
+ <<<\<username\>>>> and <<<\<password\>>>> in the <<<\<configuration\>>>>
+ section:
-------------------
<project>
Modified:
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/specifying-mail-sender.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/specifying-mail-sender.apt?rev=620334&r1=620333&r2=620334&view=diff
==============================================================================
---
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/specifying-mail-sender.apt
(original)
+++
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/specifying-mail-sender.apt
Sun Feb 10 13:33:14 2008
@@ -1,5 +1,5 @@
------
- Specifying the mail sender
+ Specifying the Mail Sender
------
Stephane Nicoll
------
@@ -24,18 +24,18 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
-Specifying the mail sender
+Specifying the Mail Sender
- The identify used to send announcement mail can be customized. It can be
either a
- member of the <<<developers>>> section of the pom or it can be specified
explicitely
- with the <<<mailSender>>> configuration of the plugin
+ The identify used to send the announcement mail can be customized. It can be
+ either a member of the <<<\<developers\>>>> section of the pom or it can be
+ specified explicitly with the <<<\<mailSender\>>>> parameter of the plugin.
* Specifying the developer to use
- To specify the developer to use to send the announcement, simply specify the
<<<id>>> of
+ To specify which developer is used to send the announcement, simply specify
the <<<id>>> of
the developer as in the example below:
+-----------------+
@@ -46,7 +46,9 @@
<id>jsmith</id>
<name>John Smith</name>
<email>[EMAIL PROTECTED]</email>
- </developer>
+ </developer>
+ ...
+ </developers>
...
<reporting>
<plugins>
@@ -63,12 +65,20 @@
</project>
+-----------------+
- If no developer id is specified, the first developer in the list will be
used.
+ If no developer <<<id>>> is specified, the first <<<\<developer\>>>> in the
list will be used.
+
+ You can also do this from the command line, if the person doing the release
+ changes between releases.
+
++-----------------+
+mvn -Dchanges.fromDeveloperId=jsmith announcement-mail
++-----------------+
+
-* Specifying the sender explicitely
+* Specifying the sender explicitly
- If you want to specify the sender explicitely and not rely on the
<<<developers>>> section of your pom,
- define the <<<mailSender>>> attribute of the plugin.
+ If you want to specify the sender explicitly and not rely on the
<<<developers>>> section of your pom,
+ define the <<<mailSender>>> parameter of the plugin.
+-----------------+
<project>
Modified:
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/using-a-custom-announcement-template.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/using-a-custom-announcement-template.apt?rev=620334&r1=620333&r2=620334&view=diff
==============================================================================
---
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/using-a-custom-announcement-template.apt
(original)
+++
maven/plugins/trunk/maven-changes-plugin/src/site/apt/examples/using-a-custom-announcement-template.apt
Sun Feb 10 13:33:14 2008
@@ -24,12 +24,12 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
Using a Custom Announcement Template
- The announcement Mojo uses a {{{http://velocity.apache.org/}Velocity}}
+ The announcement goal uses a {{{http://velocity.apache.org/}Velocity}}
template to create an announcement. If you want to, you can create your own
custom template.
@@ -37,10 +37,10 @@
First you must configure the plugin and tell it where your template is. In
this example we want to use the template
- <<<${basedir}/src/main/resources/our-announcements/my-announcement.vm>>>.
+ <<<$\{basedir\}/src/main/resources/our-announcements/my-announcement.vm>>>.
- <<Note:>> The <<<templateDirectory>>> must be a subdirectory of
- <<<${basedir}/src/main/resources/>>>.
+ <<Note:>> The <<<\<templateDirectory\>>>> must be a subdirectory of
+ <<<$\{basedir\}/src/main/resources/>>>.
+-----------------+
<project>
@@ -61,6 +61,7 @@
</project>
+-----------------+
+
* Creating Your Template
Next you want to create your own template. A wise thing is to start with the
@@ -70,6 +71,7 @@
It will provide you with examples on how to iterate over the actions of a
release among other things.
+
* Available Variables
Here's a list of the variables that you have at your disposal, when creating
@@ -117,7 +119,7 @@
*-----------------+----------+-------------+
<Variables marked with * are read-only.>
- Finally each <<<Action>>> has its own set of variables:
+ Finally each <<<Action>>> has the following variables:
*-----------------+----------+-------------+
| <<Variable>> | <<Type>> | <<Contents>>
@@ -136,6 +138,6 @@
*-----------------+----------+-------------+
<Variables marked with * are read-only.>
- For more information on how to access variables in your template and more,
+ For information on how to access variables in your template and more,
please see the
{{{http://velocity.apache.org/engine/releases/velocity-1.4/user-guide.html}Velocity
user guide}}.
Modified: maven/plugins/trunk/maven-changes-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/site/apt/index.apt?rev=620334&r1=620333&r2=620334&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/site/apt/index.apt Sun Feb 10
13:33:14 2008
@@ -24,7 +24,7 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
Maven 2 Changes Plugin
@@ -44,7 +44,7 @@
* {{{changes-report-mojo.html}changes:changes-report}} create a report
showing what has changed between different releases of the project.
- * {{{jira-report-mojo.html}changes:jira-report}} creates a report on issues
downloaded from JIRA.
+ * {{{jira-report-mojo.html}changes:jira-report}} create a report from issues
downloaded from JIRA.
[]
Modified: maven/plugins/trunk/maven-changes-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/site/apt/usage.apt?rev=620334&r1=620333&r2=620334&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/site/apt/usage.apt Sun Feb 10
13:33:14 2008
@@ -25,16 +25,18 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
Usage
- This plugin is used to create a Changes Report, a JIRA Report and an
Announcement text file.
+ This plugin is used to create a Changes Report, a JIRA Report and an
+ Announcement text file. It is also able to send the announcement via email.
+
*How to Generate the Changes Report
-
- In order to use this plugin, simply create a <<<changes.xml>>> file under the
<<<src/changes/>>> directory.
+
+ In order to use this goal, simply create a <<<changes.xml>>> file in the
<<<src/changes/>>> directory.
Here's an example of a typical <<<changes.xml>>>, showing the syntax:
-------------------
@@ -66,38 +68,12 @@
</document>
-------------------
- The following attributes are supported for the <<<\<release\>>>> element:
-
-*--------------------+--------------*------------------------------------------------------------------------------------------+
-<<Attribute>> | <<Optional>> | <<Description>>
-*--------------------+--------------*------------------------------------------------------------------------------------------+
-version | Required | Name of the version in which the
changes occur. For each change, add a nested <<<\<action\>>>> element as
described below.
-*--------------------+--------------*------------------------------------------------------------------------------------------+
-date | Required | Date at which the version was released.
You can use a free form comment such as "in SVN" for unreleased versions.
-*--------------------+--------------*------------------------------------------------------------------------------------------+
-description | Optional | An optional description of the release.
This is used in the overview table of releases. <<Note:>> In releases prior to
2.0-beta-2 this was called <<<desc>>>. It was changed to improve compatibility
with the Maven 1 changes plugin.
-*--------------------+--------------*------------------------------------------------------------------------------------------+
-
- The following attributes are supported for the <<<\<action\>>>> element:
-
-*--------------------+--------------*------------------------------------------------------------------------------------------+
-<<Attribute>> | <<Optional>> | <<Description>>
-*--------------------+--------------*------------------------------------------------------------------------------------------+
-dev | Required | Name of developer who committed the
change. This must be the name of the developer as described in the developers
section of the <<<pom.xml>>> file.
-*--------------------+--------------*------------------------------------------------------------------------------------------+
-type | Required | Type of change. There are four valid
values: <add>, <fix>, <remove>, <update>.
-*--------------------+--------------*------------------------------------------------------------------------------------------+
-issue | Optional | Id of the issue related to this change.
This is the id in your issue tracking system.
- | | The Changes plugin will generate a URL
out of this id. The URL is constructed using the value of the
<<<issueLinkTemplate>>> parameter. See the
{{{changes-report-mojo.html}changes-report mojo}} for more details.
-*--------------------+--------------*------------------------------------------------------------------------------------------+
-due-to | Optional | Name of the person to be credited for
this change. This can be used when a patch is submitted by a non-committer.
-*--------------------+--------------*------------------------------------------------------------------------------------------+
-due-to-email | Optional | Email of the person to be credited for
this change.
-*--------------------+--------------*------------------------------------------------------------------------------------------+
+ See the {{{changes.html}Changes Reference}} for details regarding the
+ <<<\<release\>>>> and <<<\<action\>>>> elements and their attributes.
+ To generate the Changes Report, insert the Changes Plugin in the
+ <<<\<reporting\>>>> section of your project's <<<pom.xml>>>
- To generate the changes report, insert the changes plugin in the
<<<\<reporting\>>>> section of your project <<<pom.xml>>>
-
-------------------
<project>
...
@@ -118,8 +94,8 @@
</reporting>
...
</project>
--------------------
-
+-------------------
+
and execute the site goal to generate the report.
-------------------
@@ -146,23 +122,24 @@
*How to Generate the JIRA Report
- <<Note:>> To use the JIRA Report, the <<<\<issueManagement\>>>> section in
the <<<pom.xml>>> of the project must be configured.
+ <<Note:>> To use the JIRA Report, the <<<\<issueManagement\>>>> section in
+ the <<<pom.xml>>> of your project must be configured. It might look something
+ like this:
- Sample code inside your <<<pom.xml>>>:
-
-------------------
<project>
...
<issueManagement>
+ <system>JIRA</system>
<url>http://jira.codehaus.org/BrowseProject.jspa?id=10450</url>
</issueManagement>
...
</project>
-------------------
+ To generate the JIRA Report, insert the Changes Plugin in the
+ <<<\<reporting\>>>> section of your project's <<<pom.xml>>>
- To generate the JIRA report, insert the changes plugin in the
<<<\<reporting\>>>> section of your project <<<pom.xml>>>
-
-------------------
<project>
...
@@ -183,18 +160,27 @@
</reporting>
...
</project>
--------------------
-
+-------------------
+
and execute the site goal to generate the report.
-------------------
mvn site
-------------------
+ For info on how to modify the JIRA Report see the
+ {{{examples/customizing-jira-report.html}Customizing the JIRA Report}}
+ example.
+
+
+*How to generate and send the Announcement via Email
-*How to generate and send the Announcement in Email
+ As usual we start by configuring your project's <<<pom.xml>>>. We add a basic
+ configuration for sending emails and specify the lucky recipients of the
+ announcement emails.
- In your project <<<pom.xml>>>, insert this segment:
+ For info on how to change the sender of the email see the
+ {{{examples/specifying-mail-sender.html}Specifying the mail sender}} example.
-------------------
<project>
@@ -204,27 +190,15 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-changes-plugin</artifactId>
- <executions>
- <execution>
- <goals>
- <goal>announcement-generate</goal>
- </goals>
- <id>announcement-generate</id>
- </execution>
- <execution>
- <goals>
- <goal>announcement-mail</goal>
- </goals>
- <id>announcement-mail</id>
- </execution>
- </executions>
<configuration>
+ ...
<smtpHost>mail.yourhost.com</smtpHost>
<smtpPort implementation="java.lang.Integer">25</smtpPort>
<toAddresses>
<toAddress implementation="java.lang.String">[EMAIL
PROTECTED]</toAddress>
<toAddress implementation="java.lang.String">[EMAIL
PROTECTED]</toAddress>
</toAddresses>
+ ...
</configuration>
</plugin>
</plugins>
@@ -233,14 +207,15 @@
</project>
-------------------
- You can generate the announcement by executing the command below:
+ You can now generate the announcement by executing the command below:
-------------------
mvn changes:announcement-generate
-------------------
- If you want to generate the announcement based on JIRA you would execute the
- following command:
+ If you want to generate the announcement based on JIRA you would either
+ configure it in your <<<pom.xml>>> or you would add the appropriate parameter
+ on the command line, like this:
-------------------
mvn changes:announcement-generate -DgenerateJiraAnnouncement=true
Modified: maven/plugins/trunk/maven-changes-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/site/site.xml?rev=620334&r1=620333&r2=620334&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/site/site.xml Sun Feb 10
13:33:14 2008
@@ -25,14 +25,18 @@
<item name="Usage" href="usage.html"/>
<item name="FAQ" href="faq.html"/>
</menu>
+ <menu name="Reference">
+ <item name="changes.xml" href="changes.html"/>
+ </menu>
<menu name="Samples">
<item name="Sample Changes Report" href="changes-report.html"/>
<item name="Live JIRA Report" href="jira-report.html"/>
</menu>
-
<menu name="Examples">
<item name="Alternate Location for the changes.xml File"
href="examples/alternate-changes-xml-location.html"/>
+ <item name="Customizing the JIRA Report"
href="examples/customizing-jira-report.html"/>
<item name="SMTP Authentication"
href="examples/smtp-authentication.html"/>
+ <item name="Specifying the Mail Sender"
href="examples/specifying-mail-sender.html"/>
<item name="Using a Custom Announcement Template"
href="examples/using-a-custom-announcement-template.html"/>
</menu>
</body>
