[jboss-svn-commits] JBL Code SVN: r14489 - in labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin: src and 2 other directories.

jboss-svn-commits at lists.jboss.org jboss-svn-commits at lists.jboss.org
Thu Aug 23 12:31:30 EDT 2007


Author: pgier
Date: 2007-08-23 12:31:30 -0400 (Thu, 23 Aug 2007)
New Revision: 14489

Added:
   labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/
   labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/
   labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/index.apt
   labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/usage.apt
   labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/site.xml
Modified:
   labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/pom.xml
Log:
Adding site configuration and documentation.

Modified: labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/pom.xml
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/pom.xml	2007-08-23 16:30:39 UTC (rev 14488)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/pom.xml	2007-08-23 16:31:30 UTC (rev 14489)
@@ -10,10 +10,24 @@
   <packaging>maven-plugin</packaging>
   <name>JBoss Deploy Maven Plugin</name>
   <version>1.4-SNAPSHOT</version>
-  <description>Plugin for deploying artifacts to JBoss non-maven repository.</description>
+  <description>Plugin for deploying artifacts to JBoss ant/buildmagic repository.</description>
+  <url>http://labs.jboss.com/maven-jboss-deploy-plugin</url>
   <scm>
     <connection>scm:svn:https://svn.jboss.org/repos/labs/labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin</connection>
   </scm>
+  <inceptionYear>2007</inceptionYear>
+  <issueManagement>
+    <system>jira</system>
+    <url>http://jira.jboss.com/jira/browse/JBBUILD</url>
+  </issueManagement>
+  <developers>
+    <developer>
+      <id>pgier</id>
+      <name>Paul Gier</name>
+      <organization>JBoss, a division of Red Hat, Inc</organization>
+      <timezone>-5</timezone>
+    </developer>
+  </developers>
   <build>
     <plugins>
       <plugin>
@@ -24,6 +38,7 @@
       </plugin>
     </plugins>
   </build>
+  
   <repositories>
     <repository>
       <id>repository.jboss.org</id>
@@ -34,6 +49,28 @@
       </snapshots>
     </repository>
   </repositories>
+  
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <configuration>
+          <minmemory>128m</minmemory>
+          <maxmemory>512</maxmemory>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jxr-plugin</artifactId>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-plugin-plugin</artifactId>
+      </plugin>
+    </plugins>
+  </reporting>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>
@@ -67,4 +104,25 @@
       <scope>test</scope>
     </dependency>
   </dependencies>
+  
+  <distributionManagement>
+    <repository>
+      <!-- Copy the distribution jar file to a local checkout of the maven repository 
+        -  This variable can be set in $MAVEN_HOME/conf/settings.xml -->
+      <id>repository.jboss.org</id>
+      <url>file://${maven.repository.root}</url>
+    </repository>
+    <snapshotRepository>
+      <id>snapshots.jboss.org</id>
+      <name>JBoss Snapshot Repository</name>
+      <url>dav:https://snapshots.jboss.org/maven2</url>
+    </snapshotRepository>
+    <site>
+      <id>www.jboss.org</id>
+      <name>www.jboss.org</name>
+      <!-- This should be set to a local checkout of the jboss.org/jbossretro freezone. -->
+      <url>file://${maven.jboss.deploy.plugin.site.root}</url>
+    </site>
+  </distributionManagement>
+  
 </project>
\ No newline at end of file

Added: labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/index.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/index.apt	                        (rev 0)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/index.apt	2007-08-23 16:31:30 UTC (rev 14489)
@@ -0,0 +1,37 @@
+ ------
+ Introduction
+ ------
+ Paul Gier
+ ------
+ 23 August 2007
+ ------
+
+~~ Copyright © 2007  Red Hat Middleware, LLC. All rights reserved.
+~~
+~~ This copyrighted material is made available to anyone wishing to use, modify,
+~~ copy, or redistribute it subject to the terms and conditions of the GNU
+~~ Lesser General Public License, v. 2.1. This program is distributed in the
+~~ hope that it will be useful, but WITHOUT A WARRANTY; without even the implied
+~~ warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+~~ Lesser General Public License for more details. You should have received a
+~~ copy of the GNU Lesser General Public License, v.2.1 along with this
+~~ distribution; if not, write to the Free Software Foundation, Inc.,
+~~ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+~~
+~~ Red Hat Author(s): Paul Gier
+
+jboss-deploy Plugin
+
+    This plugin allows maven based projects to deploy project artifacts (jars, etc) 
+    to the legacy ant/buildmagic based repository.  Deployment to the standard maven 
+    repository should be done using the standard maven-deploy-plugin.  The main
+    features of this plugin include generating a component-info.xml file, and 
+    copying project artifacts to a local directory which contains a checkout of
+    the ant repository.
+    
+    Note: when using this plugin it may be necessary to visually inspect the generated
+    component-info.xml file to be sure that everything is correct.
+
+* Usage
+
+    Detailed usage instructions for the <jboss-deploy Plugin> can be found {{{usage.html}here}}.

Added: labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/usage.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/usage.apt	                        (rev 0)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/usage.apt	2007-08-23 16:31:30 UTC (rev 14489)
@@ -0,0 +1,125 @@
+ ------
+ Usage
+ ------
+ Paul Gier
+ ------
+ 2 July 2007
+ ------
+
+~~ Copyright © 2007  Red Hat Middleware, LLC. All rights reserved.
+~~
+~~ This copyrighted material is made available to anyone wishing to use, modify,
+~~ copy, or redistribute it subject to the terms and conditions of the GNU
+~~ Lesser General Public License, v. 2.1. This program is distributed in the
+~~ hope that it will be useful, but WITHOUT A WARRANTY; without even the implied
+~~ warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+~~ Lesser General Public License for more details. You should have received a
+~~ copy of the GNU Lesser General Public License, v.2.1 along with this
+~~ distribution; if not, write to the Free Software Foundation, Inc.,
+~~ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+~~
+~~ Red Hat Author(s): Paul Gier
+
+Usage
+
+    The <jboss-deploy Plugin> generates the required information to deploy a maven built
+    project to the ant/buildmagic based repository.
+
+* Minimal configuration
+
+    The most basic configuration of the <jboss-deploy Plugin> is to simply tell the plugin
+    the default goal to execute and where to deploy artifacts:
+
++----+
+      <plugin>
+        <groupId>org.jboss.maven.plugins</groupId>
+        <artifactId>maven-jboss-deploy-plugin</artifactId>
+        <executions>
+          <execution>
+            <goals>
+              <goal>jboss-deploy</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <jbossDeployRoot>${jboss.repository.root}</jbossDeployRoot>
+        </configuration>
+      </plugin>
++----+
+
+* Configuring component-info.xml
+
+    In many cases it will be necessary to customize the generated component-info.xml
+    file.  The following example shows a groupId and license to use instead of the 
+    groupId and license found in the pom.xml
+
++----+
+      <plugin>
+        <groupId>org.jboss.maven.plugins</groupId>
+        <artifactId>maven-jboss-deploy-plugin</artifactId>
+        <executions>
+          <execution>
+            <goals>
+              <goal>jboss-deploy</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <groupId>jboss</groupId>
+          <license>lgpl</license>
+          <jbossDeployRoot>${jboss.repository.root}</jbossDeployRoot>
+        </configuration>
+      </plugin>
++----+
+
+    This example shows how to customize the imports (dependencies) contained in 
+    the component-info.xml
+
++----+
+      <plugin>
+        <groupId>org.jboss.maven.plugins</groupId>
+        <artifactId>maven-jboss-deploy-plugin</artifactId>
+        <executions>
+          <execution>
+            <goals>
+              <goal>jboss-deploy</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <imports>
+            <javassist>3.5, 3.6-beta1</javassist>
+          </imports>
+          <jbossDeployRoot>${jboss.repository.root}</jbossDeployRoot>
+        </configuration>
+      </plugin>
++----+
+
+    As you can see from the example, each import should have the component name for the tag,
+    and a comma-separated list of compatible versions to import.
+    The above configuration will generate a component-info.xml file that looks something like this:
+    
++----+
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="jboss/jboss-test-component-info">
+  <component id="jboss/jboss-test"
+             licenseType="lgpl"
+             version="0.0.1"
+             description="jboss:jboss-retro-tests:jar:0.0.1"
+             
+             > 
+              
+    <artifact id="jboss-test-0.0.1.jar"/>
+
+    <import componentref="javassist">
+      <compatible version="3.5"/>
+      <compatible version="3.6-beta1"/>
+    </import>
+
+    <export>
+      <include input="jboss-test-0.0.1.jar"/>
+
+    </export>
+  </component>
+</project>
++----+

Added: labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/site.xml
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/site.xml	                        (rev 0)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/site.xml	2007-08-23 16:31:30 UTC (rev 14489)
@@ -0,0 +1,27 @@
+<project name="Maven JBoss Deploy Plugin">
+  <bannerLeft>
+    <name>Maven JBoss Deploy Plugin</name>
+    <href>http://www.jboss.org/maven-jboss-deploy-plugin</href>
+  </bannerLeft>
+  <bannerRight>
+    <name>JBoss.org</name>
+    <src>http://www.jboss.org/</src>
+  </bannerRight>
+  <skin>
+    <groupId>org.jboss.maven.skins</groupId>
+    <artifactId>maven-body-only-skin</artifactId>
+  </skin>
+  <publishDate format="dd MMM yyyy" />
+  <body>
+    <links>
+      <item name="JBoss" href="http://www.jboss.org/"/>
+    </links>
+    <head>
+      <meta name="faq" content="proficio"/>
+    </head>
+    <menu name="Quick Links">
+      <item name="Features" href="/maven-features.html"/>
+    </menu>
+    ${reports}
+  </body>
+</project>




More information about the jboss-svn-commits mailing list