Author: manik.surtani(a)jboss.com Date: 2008-05-14 07:48:46 -0400 (Wed, 14 May 2008) New Revision: 5841 Modified: core/trunk/README-Maven.txt core/trunk/pom.xml Log: Updated maven builds. Modified: core/trunk/README-Maven.txt =================================================================== --- core/trunk/README-Maven.txt 2008-05-14 11:24:44 UTC (rev 5840) +++ core/trunk/README-Maven.txt 2008-05-14 11:48:46 UTC (rev 5841) @@ -14,15 +14,19 @@ Maven will create a target/ directory under the root for the creation of output at every stage. -* mvn clean: cleans out any old builds and binaries +* mvn clean: Cleans out any old builds and binaries -* mvn compile: compiles java source code. +* mvn compile: Compiles java source code. -* mvn test: runs the TestNG unit test suite on the compiled code. Will also compile the tests. See the testing section - below for more information. +* mvn test: Runs the TestNG unit test suite on the compiled code. Will also compile the tests. See the testing section + below for more information on running different test groups. The default test group run is the "unit" group. -* mvn package: packages the module as a jar file and builds the javadocs and user documentation from docbook sources. +* mvn package: Packages the module as a JAR file, the resulting JAR file will be in target/ +* mvn package -Dmaven.test.skip=true: Creates a JAR file without running tests. + +* mvn package -P Docs: Packages the module as a JAR file, and builds the javadocs and user documentation from docbook sources. + * mvn install: will install the artifacts in your local repo for use by other projects (such as JBoss Cache POJO edition which depends on JBoss Cache Core). Will also use Maven's assembly plugin to build ZIP files for download (in target/distribution) Modified: core/trunk/pom.xml =================================================================== --- core/trunk/pom.xml 2008-05-14 11:24:44 UTC (rev 5840) +++ core/trunk/pom.xml 2008-05-14 11:48:46 UTC (rev 5841) @@ -5,7 +5,12 @@ <modelVersion>4.0.0</modelVersion> <properties> <jbosscache-core-version>2.2.0-SNAPSHOT</jbosscache-core-version> + <!-- By default only run tests in the "unit" group --> + <defaultTestGroup>unit</defaultTestGroup> + <!-- By default only generate Javadocs when we install the module. --> + <javadocPhase>install</javadocPhase> </properties> + <parent> <groupId>org.jboss.cache</groupId> <artifactId>jbosscache-common-parent</artifactId> @@ -172,151 +177,6 @@ </execution> </executions> </plugin> - <!-- the docbook generation plugin for the user guide --> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.0.0</version> - <extensions>true</extensions> - <dependencies> - <dependency> - <groupId>org.jboss</groupId> - <artifactId>jbossorg-docbook-xslt</artifactId> - <version>1.1.0.Beta1</version> - </dependency> - <dependency> - <groupId>org.jboss</groupId> - <artifactId>jbossorg-jdocbook-style</artifactId> - <version>1.1.0.Beta1</version> - <type>jdocbook-style</type> - </dependency> - </dependencies> - <executions> - - <!-- The User Guide--> - <execution> - <id>userguide_en</id> - <phase>package</phase> - <goals> - <goal>resources</goal> - <goal>generate</goal> - </goals> - <configuration> - <sourceDocumentName>master.xml</sourceDocumentName> - <sourceDirectory>${basedir}/src/main/docbook/userguide/en</sourceDirectory> - <imageResource> - <directory>${basedir}/src/main/docbook/images</directory> - </imageResource> - <cssResource> - <directory>${basedir}/src/main/docbook/css</directory> - </cssResource> - <targetDirectory>${basedir}/target/docbook/userguide_en</targetDirectory> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>userguide_en.pdf</finalName> - </format> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>html_single</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - <options> - <xincludeSupported>false</xincludeSupported> - </options> - </configuration> - </execution> - - <!-- The Tutorial --> - <execution> - <id>tutorial_en</id> - <phase>package</phase> - <goals> - <goal>resources</goal> - <goal>generate</goal> - </goals> - <configuration> - <sourceDocumentName>master.xml</sourceDocumentName> - <sourceDirectory>${basedir}/src/main/docbook/tutorial/en</sourceDirectory> - <imageResource> - <directory>${basedir}/src/main/docbook/images</directory> - </imageResource> - <cssResource> - <directory>${basedir}/src/main/docbook/css</directory> - </cssResource> - <targetDirectory>${basedir}/target/docbook/tutorial_en</targetDirectory> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>tutorial_en.pdf</finalName> - </format> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>html_single</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - <options> - <xincludeSupported>false</xincludeSupported> - </options> - </configuration> - </execution> - - <!-- the FAQs --> - <execution> - <id>faq_en</id> - <phase>package</phase> - <goals> - <goal>resources</goal> - <goal>generate</goal> - </goals> - <configuration> - <sourceDocumentName>master.xml</sourceDocumentName> - <sourceDirectory>${basedir}/src/main/docbook/faq/en</sourceDirectory> - <imageResource> - <directory>${basedir}/src/main/docbook/images</directory> - </imageResource> - <cssResource> - <directory>${basedir}/src/main/docbook/css</directory> - </cssResource> - <targetDirectory>${basedir}/target/docbook/faq_en</targetDirectory> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>faq_en.pdf</finalName> - </format> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>html_single</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - <options> - <xincludeSupported>false</xincludeSupported> - </options> - </configuration> - </execution> - </executions> - </plugin> </plugins> </build> @@ -339,6 +199,166 @@ <profiles> <profile> + <!-- This profile generates Javadocs and the UserGuide, FAQs and Tutorial in the "package" phase. --> + <id>Docs</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <properties> + <!-- override to generate javadocs in the "package" phase --> + <javadocPhase>package</javadocPhase> + </properties> + <build> + <plugins> + <!-- the docbook generation plugin for the user guide --> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.0.0</version> + <extensions>true</extensions> + <dependencies> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-docbook-xslt</artifactId> + <version>1.1.0.Beta1</version> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.1.0.Beta1</version> + <type>jdocbook-style</type> + </dependency> + </dependencies> + <executions> + + <!-- The User Guide--> + <execution> + <id>userguide_en</id> + <phase>package</phase> + <goals> + <goal>resources</goal> + <goal>generate</goal> + </goals> + <configuration> + <sourceDocumentName>master.xml</sourceDocumentName> + <sourceDirectory>${basedir}/src/main/docbook/userguide/en</sourceDirectory> + <imageResource> + <directory>${basedir}/src/main/docbook/images</directory> + </imageResource> + <cssResource> + <directory>${basedir}/src/main/docbook/css</directory> + </cssResource> + <targetDirectory>${basedir}/target/docbook/userguide_en</targetDirectory> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>userguide_en.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <xincludeSupported>false</xincludeSupported> + </options> + </configuration> + </execution> + + <!-- The Tutorial --> + <execution> + <id>tutorial_en</id> + <phase>package</phase> + <goals> + <goal>resources</goal> + <goal>generate</goal> + </goals> + <configuration> + <sourceDocumentName>master.xml</sourceDocumentName> + <sourceDirectory>${basedir}/src/main/docbook/tutorial/en</sourceDirectory> + <imageResource> + <directory>${basedir}/src/main/docbook/images</directory> + </imageResource> + <cssResource> + <directory>${basedir}/src/main/docbook/css</directory> + </cssResource> + <targetDirectory>${basedir}/target/docbook/tutorial_en</targetDirectory> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>tutorial_en.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <xincludeSupported>false</xincludeSupported> + </options> + </configuration> + </execution> + + <!-- the FAQs --> + <execution> + <id>faq_en</id> + <phase>package</phase> + <goals> + <goal>resources</goal> + <goal>generate</goal> + </goals> + <configuration> + <sourceDocumentName>master.xml</sourceDocumentName> + <sourceDirectory>${basedir}/src/main/docbook/faq/en</sourceDirectory> + <imageResource> + <directory>${basedir}/src/main/docbook/images</directory> + </imageResource> + <cssResource> + <directory>${basedir}/src/main/docbook/css</directory> + </cssResource> + <targetDirectory>${basedir}/target/docbook/faq_en</targetDirectory> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>faq_en.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <xincludeSupported>false</xincludeSupported> + </options> + </configuration> + </execution> + </executions> + </plugin> + </plugins> + </build> + </profile> + <profile> <id>JBossAS</id> <activation> <activeByDefault>false</activeByDefault> @@ -376,5 +396,4 @@ </dependencies> </profile> </profiles> - </project>