o MAVEN-290: Use changes.xml again
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@112982 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
bwalding
parent
8628833cb9
commit
d163728443
3
changes/.cvsignore
Normal file
3
changes/.cvsignore
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
target
|
||||||
|
velocity.log
|
||||||
|
maven.log
|
||||||
45
changes/plugin.jelly
Normal file
45
changes/plugin.jelly
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
<?xml version="1.0"?>
|
||||||
|
|
||||||
|
<project
|
||||||
|
xmlns:j="jelly:core"
|
||||||
|
xmlns:define="jelly:define"
|
||||||
|
xmlns:util="jelly:util"
|
||||||
|
xmlns:doc="doc">
|
||||||
|
|
||||||
|
<goal name="maven-changes-plugin:register">
|
||||||
|
<property name="maven.docs.src" value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('maven.docs.src')}"/>
|
||||||
|
<util:file var="changes" name="${maven.docs.src}/changes.xml"/>
|
||||||
|
<j:if test="${changes.exists()}">
|
||||||
|
<doc:registerReport
|
||||||
|
name="Changes"
|
||||||
|
pluginName="maven-changes-plugin"
|
||||||
|
link="changes-report"
|
||||||
|
description="Report on the project changes."/>
|
||||||
|
</j:if>
|
||||||
|
</goal>
|
||||||
|
|
||||||
|
<goal name="maven-changes-plugin:deregister">
|
||||||
|
<doc:deregisterReport name="Changes"/>
|
||||||
|
</goal>
|
||||||
|
|
||||||
|
<!-- ================================================================== -->
|
||||||
|
<!-- C H A N G E L O G R E P O R T -->
|
||||||
|
<!-- ================================================================== -->
|
||||||
|
|
||||||
|
<goal
|
||||||
|
name="maven-changes-plugin:report"
|
||||||
|
description="Generate a changes report">
|
||||||
|
<property name="maven.docs.src" value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('maven.docs.src')}"/>
|
||||||
|
|
||||||
|
<doc:jsl
|
||||||
|
input="${maven.docs.src}/changes.xml"
|
||||||
|
output="changes-report.xml"
|
||||||
|
stylesheet="${plugin.resources}/changes.jsl"
|
||||||
|
encoding="${maven.docs.outputencoding}"
|
||||||
|
omitXmlDeclaration="false"
|
||||||
|
outputMode="xml"
|
||||||
|
prettyPrint="true"
|
||||||
|
/>
|
||||||
|
|
||||||
|
</goal>
|
||||||
|
</project>
|
||||||
12
changes/plugin.properties
Normal file
12
changes/plugin.properties
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# -------------------------------------------------------------------
|
||||||
|
# P L U G I N P R O P E R I E S
|
||||||
|
# -------------------------------------------------------------------
|
||||||
|
# changes plugin.
|
||||||
|
# -------------------------------------------------------------------
|
||||||
|
# These three don't belong here.
|
||||||
|
maven.build.dir = ${basedir}/target
|
||||||
|
maven.gen.docs = ${maven.build.dir}/generated-xdocs
|
||||||
|
maven.docs.outputencoding = ISO-8859-1
|
||||||
|
|
||||||
|
maven.changelog.range = 30
|
||||||
|
maven.changelog.factory = org.apache.maven.cvslib.CvsChangeLogFactory
|
||||||
7
changes/project.properties
Normal file
7
changes/project.properties
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
# -------------------------------------------------------------------
|
||||||
|
# P R O J E C T P R O P E R T I E S
|
||||||
|
# -------------------------------------------------------------------
|
||||||
|
maven.xdoc.date=left
|
||||||
|
maven.xdoc.version=${pom.currentVersion}
|
||||||
|
maven.license.licenseFile=${basedir}/../../../LICENSE.txt
|
||||||
|
|
||||||
62
changes/project.xml
Normal file
62
changes/project.xml
Normal file
@ -0,0 +1,62 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
|
||||||
|
<project>
|
||||||
|
<extend>${basedir}/../project.xml</extend>
|
||||||
|
<pomVersion>3</pomVersion>
|
||||||
|
<id>maven-changes-plugin</id>
|
||||||
|
<name>Maven Changes Plug-in</name>
|
||||||
|
<currentVersion>1.2</currentVersion>
|
||||||
|
<shortDescription>Java Project Management Tools</shortDescription>
|
||||||
|
|
||||||
|
<url>http://jakarta.apache.org/turbine/maven/reference/plugins/changelog/</url>
|
||||||
|
<issueTrackingUrl>http://jira.werken.com/BrowseProject.jspa?id=10030</issueTrackingUrl>
|
||||||
|
<siteAddress>jakarta.apache.org</siteAddress>
|
||||||
|
<siteDirectory>/www/jakarta.apache.org/turbine/maven/reference/plugins/changelog/</siteDirectory>
|
||||||
|
<distributionDirectory>/www/jakarta.apache.org/builds/jakarta-turbine-maven/</distributionDirectory>
|
||||||
|
<developers>
|
||||||
|
<developer>
|
||||||
|
<name>Ben Walding</name>
|
||||||
|
<id>bwalding</id>
|
||||||
|
<email>bwalding@apache.org</email>
|
||||||
|
<organization></organization>
|
||||||
|
<roles>
|
||||||
|
<role>Java Developer</role>
|
||||||
|
</roles>
|
||||||
|
</developer>
|
||||||
|
</developers>
|
||||||
|
|
||||||
|
<dependencies>
|
||||||
|
<dependency>
|
||||||
|
<id>ant</id>
|
||||||
|
<version>1.5.1</version>
|
||||||
|
<properties>
|
||||||
|
<classloader>root</classloader>
|
||||||
|
</properties>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>commons-jelly</groupId>
|
||||||
|
<artifactId>commons-jelly-tags-jsl</artifactId>
|
||||||
|
<version>20030211.143151</version>
|
||||||
|
<properties>
|
||||||
|
<classloader>root.maven</classloader>
|
||||||
|
</properties>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>commons-jelly</groupId>
|
||||||
|
<artifactId>commons-jelly-tags-xml</artifactId>
|
||||||
|
<version>20030211.142705</version>
|
||||||
|
<url>http://jakarta.apache.org/commons/jelly/tags/xml/</url>
|
||||||
|
<properties>
|
||||||
|
<classloader>root.maven</classloader>
|
||||||
|
</properties>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<id>commons-logging</id>
|
||||||
|
<version>1.0.1</version>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<id>junit</id>
|
||||||
|
<version>3.8.1</version>
|
||||||
|
</dependency>
|
||||||
|
</dependencies>
|
||||||
|
</project>
|
||||||
1
changes/xdocs/.cvsignore
Normal file
1
changes/xdocs/.cvsignore
Normal file
@ -0,0 +1 @@
|
|||||||
|
stylesheets
|
||||||
31
changes/xdocs/goals.xml
Normal file
31
changes/xdocs/goals.xml
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
<?xml version="1.0"?>
|
||||||
|
<document>
|
||||||
|
|
||||||
|
<properties>
|
||||||
|
<title>Maven Ant Plug-in Goals</title>
|
||||||
|
<author email="dion@multitask.com.au">dIon Gillard</author>
|
||||||
|
</properties>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<section name="Goals">
|
||||||
|
<table>
|
||||||
|
<tr><th>Goal</th><th>Description</th></tr>
|
||||||
|
<tr>
|
||||||
|
<td>changelog</td>
|
||||||
|
<td>
|
||||||
|
This is the default goal of the plugin and simply attains
|
||||||
|
the <code>changelog:generate</code> goal.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>changelog:generate</td>
|
||||||
|
<td>
|
||||||
|
Generates a report from the source control system showing
|
||||||
|
changes by date along with the message, if any, provided
|
||||||
|
by the developer when making the change
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
</body>
|
||||||
|
</document>
|
||||||
29
changes/xdocs/index.xml
Normal file
29
changes/xdocs/index.xml
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
<?xml version="1.0"?>
|
||||||
|
<document>
|
||||||
|
|
||||||
|
<properties>
|
||||||
|
<title>Maven Changelog Plug-in</title>
|
||||||
|
<author email="jason@zenplex.com">Jason van Zyl</author>
|
||||||
|
<author email="dion@multitask.com.au">dIon Gillard</author>
|
||||||
|
</properties>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<section name="Maven Changelog Plug-in">
|
||||||
|
<p>
|
||||||
|
This plugin produces a nicely formatted changelog report so project
|
||||||
|
team members can see at a glance what changes have been made
|
||||||
|
recently to the project. Currently, there are three supported
|
||||||
|
source control systems: CVS, StarTeam and Subversion.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
For more information on the functionality provided by this plugin,
|
||||||
|
please see the <a href="goals.html">Goals</a> document.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
For more information on how to customise the functionality provided
|
||||||
|
by this plugin, please see the <a href="properties.html">properties</a>
|
||||||
|
document.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
</body>
|
||||||
|
</document>
|
||||||
18
changes/xdocs/navigation.xml
Normal file
18
changes/xdocs/navigation.xml
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||||
|
<project name="Maven Change log Plugin">
|
||||||
|
|
||||||
|
<title>Maven Change log Plugin</title>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<links>
|
||||||
|
<item name="Maven" href="http://jakarta.apache.org/turbine/maven/"/>
|
||||||
|
<item name="CVS" href="http://www.cvshome.org/"/>
|
||||||
|
<item name="StarTeam" href="http://www.starbase.com/product_starteam/"/>
|
||||||
|
<item name="Subversion" href="http://subversion.tigris.org/" />
|
||||||
|
</links>
|
||||||
|
<menu name="Overview">
|
||||||
|
<item name="Goals" href="/goals.html" />
|
||||||
|
<item name="Properties" href="/properties.html" />
|
||||||
|
</menu>
|
||||||
|
</body>
|
||||||
|
</project>
|
||||||
88
changes/xdocs/properties.xml
Normal file
88
changes/xdocs/properties.xml
Normal file
@ -0,0 +1,88 @@
|
|||||||
|
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||||
|
<document>
|
||||||
|
|
||||||
|
<properties>
|
||||||
|
<title>Changelog Properties</title>
|
||||||
|
<author email="smor@apache.org">Stéphane MOR</author>
|
||||||
|
</properties>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<section name="Changelog Properties">
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<th>Property name</th>
|
||||||
|
<th>Optional?</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>maven.changelog.range</td>
|
||||||
|
<td>Yes</td>
|
||||||
|
<td>
|
||||||
|
Specifies the range to use when generating the change log.
|
||||||
|
This is used by the "changelog" goal. The default value is
|
||||||
|
<code>5</code> days. Note: when using the Subversion
|
||||||
|
changelog factory, you <b>must</b> set this property to an
|
||||||
|
empty value because the Subversion ra_dav module (used to
|
||||||
|
access DAV repositories) does not support date operations
|
||||||
|
yet. If you are using a local repository (ra_local), then
|
||||||
|
this does not apply to you.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>maven.changelog.factory</td>
|
||||||
|
<td>Yes</td>
|
||||||
|
<td>
|
||||||
|
Specifies a fully qualified class name implementing the
|
||||||
|
<code>org.apache.maven.changelog.ChangeLogFactory</code> interface.
|
||||||
|
The class creates the <code>ChangeLogGenerator</code> and
|
||||||
|
<code>ChangeLogParser</code> pair required to create the change
|
||||||
|
log. This is used by the "changelog" and "activity" goals.
|
||||||
|
The default value is <a
|
||||||
|
href="../apidocs/org/apache/maven/cvslib/CvsChangeLogFactory.html">
|
||||||
|
org.apache.maven.cvslib.CvsChangeLogFactory</a>. In
|
||||||
|
addition, there is also a Subversion factory (<a
|
||||||
|
href="../apidocs/org/apache/maven/svnlib/SvnChangeLogFactory.html">
|
||||||
|
org.apache.maven.svnlib.SvnChangeLogFactory</a>) as well as
|
||||||
|
a StarTeam factory (<a
|
||||||
|
href="../apidocs/org/apache/maven/starteamlib/StarteamChangeLogFactory.html">
|
||||||
|
org.apache.maven.starteamlib.StarteamChangeLogFactory</a>).
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>maven.docs.outputencoding</td>
|
||||||
|
<td>Yes</td>
|
||||||
|
<td>
|
||||||
|
The output encoding for the generated xml documents. Set by
|
||||||
|
the xdoc plugin, it defaults to <code>ISO-8859-1</code>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section name="Other properties">
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<th>Property name</th>
|
||||||
|
<th>Optional?</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>maven.gen.docs</td>
|
||||||
|
<td>Yes</td>
|
||||||
|
<td>
|
||||||
|
The directory where the generated report is created.
|
||||||
|
This directory holds the generated documents for
|
||||||
|
processing by the xdoc plugin.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>maven.mode.online</td>
|
||||||
|
<td>Yes</td>
|
||||||
|
<td>
|
||||||
|
Used by the plugin to check if the user is currently 'online'
|
||||||
|
and hence has access to the source code repository.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
</body>
|
||||||
|
</document>
|
||||||
Loading…
x
Reference in New Issue
Block a user