1:18 a.m.
Author: manik.surtani(a)jboss.com
Date: 2007-08-15 02:18:44 -0400 (Wed, 15 Aug 2007)
New Revision: 4260
Added:
support/trunk/README-Maven.txt
Modified:
support/trunk/pom.xml
Log:
Added README and updated pom to deploy live releases to a local checkout of the live
repository
Added: support/trunk/README-Maven.txt
===================================================================
--- support/trunk/README-Maven.txt (rev 0)
+++ support/trunk/README-Maven.txt 2007-08-15 06:18:44 UTC (rev 4260)
@@ -0,0 +1,72 @@
+Working with Maven
+------------------
+
+You *need* to install the support modules before being able to work with the JBoss Cache
core or pojo modules. If the jbosscache-support modules are not available on a public or
snapshot repository near you, please do a "mvn install" in this directory to
build these modules and make them available on your local repository.
+
+Setting up your WebDAV username and password to deploy project snapshots
+------------------------------------------------------------------------
+
+You will also have to configure maven to use your username and password to access this
repository. For this, you will have to modify the servers section of maven settings file
($MAVEN_HOME/conf/settings.xml, or ~/.m2/settings.xml). Something similar to the following
should be added:
+
+<settings>
+
+...
+
+ <servers>
+...
+ <server>
+ <id>snapshots.jboss.org</id>
+ <username>webdav-user</username>
+ <password>webdav-pass</password>
+ </server>
+...
+
+ </servers>
+
+...
+
+</settings>
+
+Deploying a release to a live repository
+----------------------------------------
+
+Very simple. Make sure you have the version number in your pom.xml set to a non-SNAPSHOT
version. Maven will pick up on this and deploy to your release repository rather than the
snapshot repository.
+
+Sadly JBoss release repository cannot be accessed via WebDAV, as the snapshot repository
can. So what you need to do is:
+
+1) Check out the release repository from Subversion (svn co
https://svn.jboss.org/repos/repository.jboss.org/maven2)
+2) Add a property in ~/.m2/settings.xml to point to this 'local' copy of the
repo. (See maven settings below)
+3) Update your project's pom.xml to reflect a non-SNAPSHOT version number
+4) Deploy your project (mvn clean deploy)
+5) Check in your 'local' copy of the repo checked out in (1), adding any new
directories/files created by (4).
+
+Maven settings.xml
+------------------
+
+Working with the JBoss Cache source tree, I have configured my ~/.m2/settings.xml to look
like:
+
+<settings>
+
+ <servers>
+ <server>
+ <id>snapshots.jboss.org</id>
+ <username>MY_JBOSS_ORG_USERNAME</username>
+ <password>WONT_TELL_YOU</password>
+ </server>
+ </servers>
+
+
+ <profiles>
+ <profile>
+ <id>jboss</id>
+ <properties>
+
<maven.repository.root>/Users/manik/Code/maven2</maven.repository.root>
+ </properties>
+ </profile>
+ </profiles>
+
+ <activeProfiles>
+ <activeProfile>jboss</activeProfile>
+ </activeProfiles>
+
+</settings>
Modified: support/trunk/pom.xml
===================================================================
--- support/trunk/pom.xml 2007-08-15 06:17:56 UTC (rev 4259)
+++ support/trunk/pom.xml 2007-08-15 06:18:44 UTC (rev 4260)
@@ -1,44 +1,38 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
-
- <modelVersion>4.0.0</modelVersion>
-
- <groupId>org.jboss.cache</groupId>
- <artifactId>jbosscache-support</artifactId>
- <version>1.0</version>
- <packaging>pom</packaging>
-
- <name>JBoss Cache Support Modules</name>
- <description>Grouping of JBoss Cache support modules</description>
-
- <modules>
- <module>xslt</module>
- <module>common</module>
- </modules>
-
- <build>
- <!-- WebDAV plugin to upload snapshots -->
- <extensions>
- <extension>
- <groupId>org.apache.maven.wagon</groupId>
- <artifactId>wagon-webdav</artifactId>
- <version>1.0-beta-2</version>
- </extension>
- </extensions>
- </build>
-
- <distributionManagement>
- <repository>
- <id>repository.jboss.org</id>
- <name>JBoss Repository</name>
- <url>dav:https://repository.jboss.org/maven2</url>
- </repository>
- <snapshotRepository>
- <id>snapshots.jboss.org</id>
- <name>JBoss Snapshot Repository</name>
- <url>dav:https://snapshots.jboss.org/maven2</url>
- </snapshotRepository>
- </distributionManagement>
-
+<?xml version="1.0"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>org.jboss.cache</groupId>
+ <artifactId>jbosscache-support</artifactId>
+ <version>1.0</version>
+ <packaging>pom</packaging>
+ <name>JBoss Cache Support Modules</name>
+ <description>Grouping of JBoss Cache support modules</description>
+ <modules>
+ <module>xslt</module>
+ <module>common</module>
+ </modules>
+ <build>
+<!-- WebDAV plugin to upload snapshots -->
+ <extensions>
+ <extension>
+ <groupId>org.apache.maven.wagon</groupId>
+ <artifactId>wagon-webdav</artifactId>
+ <version>1.0-beta-2</version>
+ </extension>
+ </extensions>
+ </build>
+ <distributionManagement>
+ <repository>
+<!-- Copy the dist to the local checkout of the JBoss maven2 repo
${maven.repository.root} -->
+<!-- It is anticipated that ${maven.repository.root} be set in user's settings.xml
-->
+<!-- TODO : replace this with direct svn access once the svnkit providers are
available -->
+ <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>
+ </distributionManagement>
</project>