You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by jt...@apache.org on 2006/12/14 09:14:41 UTC
svn commit: r487124 - in /maven/sandbox/plugins/maven-swizzle-plugin:
pom.xml src/site/apt/examples/generating-resolved-issues-report.apt
src/site/apt/examples/generating-votes-report.apt src/site/apt/index.apt
src/site/apt/usage.apt src/site/site.xml
Author: jtolentino
Date: Thu Dec 14 00:14:41 2006
New Revision: 487124
URL: http://svn.apache.org/viewvc?view=rev&rev=487124
Log:
Additional documentation, some site documentation fixes, and maven-docck-plugin reporting compliance.
Modified:
maven/sandbox/plugins/maven-swizzle-plugin/pom.xml
maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt
maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt
maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/index.apt
maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/usage.apt
maven/sandbox/plugins/maven-swizzle-plugin/src/site/site.xml
Modified: maven/sandbox/plugins/maven-swizzle-plugin/pom.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/pom.xml?view=diff&rev=487124&r1=487123&r2=487124
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/pom.xml (original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/pom.xml Thu Dec 14 00:14:41 2006
@@ -44,6 +44,18 @@
</plugin>
</plugins>
</build>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jxr-plugin</artifactId>
+ </plugin>
+ </plugins>
+ </reporting>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
Modified: maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt?view=diff&rev=487124&r1=487123&r2=487124
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt (original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt Thu Dec 14 00:14:41 2006
@@ -55,3 +55,33 @@
[...]
</project>
+-------+
+
+*Maven WAR Plugin example
+
+ Here's an example on how to generate a report on resolved issues for the maven-war-plugin that is scheduled for its
+ 2.0.2 release:
+
++-------+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-swizzle-plugin</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <configuration>
+ <reportConfiguration>
+ <jiraServerUrl>http://jira.codehaus.org</jiraServerUrl>
+ <projectKey>MWAR</projectKey>
+ <projectVersion>2.0.2</projectVersion>
+ <template>RESOLVED_ISSUES</template>
+ </reportConfiguration>
+ <result>my-output/MavenWARPluginResolvedIssues.xml</result>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++-------+
Modified: maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt?view=diff&rev=487124&r1=487123&r2=487124
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt (original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt Thu Dec 14 00:14:41 2006
@@ -56,3 +56,32 @@
[...]
</project>
+-------+
+
+*Maven WAR Plugin example
+
+ Here's an example on how to generate a report on votes made on each open maven-war-plugin issue:
+
++-------+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-swizzle-plugin</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <configuration>
+ <reportConfiguration>
+ <jiraServerUrl>http://jira.codehaus.org</jiraServerUrl>
+ <projectKey>MWAR</projectKey>
+ <projectVersion>*</projectVersion>
+ <template>VOTES</template>
+ </reportConfiguration>
+ <result>my-output/MavenWARPluginVotes.xml</result>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++-------+
Modified: maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/index.apt?view=diff&rev=487124&r1=487123&r2=487124
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/index.apt (original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/index.apt Thu Dec 14 00:14:41 2006
@@ -34,7 +34,7 @@
The plugin's aim is to help developers check their project's health (through resolved issues report) and
identify which issues to prioritize (through votes report). Using both reports could help the project
- perform a release more often as well as answer users' needs.
+ perform a release more often as well as address users' needs.
* Goal Overview
Modified: maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/usage.apt?view=diff&rev=487124&r1=487123&r2=487124
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/usage.apt (original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/usage.apt Thu Dec 14 00:14:41 2006
@@ -24,6 +24,40 @@
Usage
+ The Maven Swizzle Plugin generate reports from a project's issue tracking system (currently only JIRA is supported).
+ It requires 5 parameters--4 parameters through the ReportConfiguration and 1 for the result output path.
+
+ Here's an example:
+
++-------+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-swizzle-plugin</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <configuration>
+ <reportConfiguration>
+ <jiraServerUrl>http://jira.codehaus.org</jiraServerUrl>
+ <projectKey>MWAR</projectKey>
+ <projectVersion>2.0.2</projectVersion>
+ <template>RESOLVED_ISSUES</template>
+ </reportConfiguration>
+ <result>my-output/MavenWARPluginResolvedIssues.xml</result>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++-------+
+
+ You can then use the generated xdoc file to create reports for your site.
+
+Goals
+
There's only one goal for the swizzle-maven-plugin:
* <<<swizzle:generate>>>
Modified: maven/sandbox/plugins/maven-swizzle-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/site.xml?view=diff&rev=487124&r1=487123&r2=487124
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/site.xml (original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/site.xml Thu Dec 14 00:14:41 2006
@@ -32,7 +32,7 @@
<menu name="Examples">
<item name="Generating Votes Report" href="examples/generating-votes-report.html"/>
<item name="Generating Resolved Issues Report" href="examples/generating-resolved-issues-report.html"/>
- <item name="Generating Custom Report" href="examples/generating-custom-report.html"/>
+ <item name="Generating A Custom Report" href="examples/generating-custom-report.html"/>
</menu>
</body>
</project>