5:15 p.m.
Author: mstruk
Date: 2011-02-01 11:15:37 -0500 (Tue, 01 Feb 2011)
New Revision: 5836
Modified:
portal/trunk/packaging/jboss-as6/README.txt
Log:
GTNMAVEN-16 Packaging that supports JBossAS6 and does away with javascript packager
- refactored jboss-as6 pom.xml, move 'pack' profile into pom build
- added 'pkg-jbossas6' profile with previous packaging kind of behaviour (exo
properties)
Modified: portal/trunk/packaging/jboss-as6/README.txt
===================================================================
--- portal/trunk/packaging/jboss-as6/README.txt 2011-02-01 15:54:13 UTC (rev 5835)
+++ portal/trunk/packaging/jboss-as6/README.txt 2011-02-01 16:15:37 UTC (rev 5836)
@@ -14,6 +14,8 @@
+
+
== Usage ==
@@ -23,14 +25,10 @@
Then go to packaging/jboss-as6 to perform packaging.
-There are three profiles that cover dependency download (-Pdownload), packaging as
exploded (-Ppack), and bundling as a zip (-Pbundle).
+There are three profiles that cover dependency download (-Pdownload), packaging as
exploded (default), and bundling as a zip (-Pbundle).
-For main build use either 'download' or 'pack' profile, but not both, as
'download' also includes 'pack' functionality.
-Both of these profiles also automatically perform 'clean' to assure consistent
results.
+For main build use either 'download' profile or no profile (default). Both of
these automatically perform 'clean' to ensure consistent results.
-Profile 'pack' is the one active by default. When activating any other profile,
the 'pack' profile is automatically turned off, so
- it may have to be explicitly activated again if packaging is required (i.e.
-Ppack,bundle).
-
There are two system properties that control where the root directory for JBoss AS
servers is located, and what specific JBoss AS directory to use.
They are preset to default location:
@@ -44,7 +42,7 @@
-== Examples ==
+== Some Examples ==
1) The simplest form uses default location for JBoss AS
@@ -53,7 +51,7 @@
This is equivalent to:
-mvn clean package -Ppack -Dservers.dir=$GATEIN/portal/trunk/packaging/servers
-Djbossas.name=jboss-6.0.0.Final
+mvn clean package -Dservers.dir=$GATEIN/portal/trunk/packaging/servers
-Djbossas.name=jboss-6.0.0.Final
2) If JBoss AS is located somewhere else adjust servers.dir and jbossas.name accordingly
@@ -65,11 +63,11 @@
mvn -Pdownload
-If SERVERS_DIR is not at default location explicitly set it:
+If SERVERS_DIR is not at default location, explicitly set it:
mvn -Pdownload -Dservers.dir=SERVERS_DIR
-You shouldn't set jbossas.name property when using -Pdownload.
+There's no need to set 'jbossas.name' property when using -Pdownload (if set,
its value should be 'jboss-6.0.0.Final').
4) Zip bundle may be produced by activating 'bundle' profile
@@ -78,8 +76,72 @@
or
-mvn -Ppack,bundle
+mvn -Pbundle
-or just
-mvn -Pbundle
+
+
+
+== Compatibility with previous packaging (PKG) ==
+
+
+The previous packaging uses two different properties to specify 'servers.dir' and
'jbossas.name':
+
+ - exo.projects.directory.dependencies (equivalent to 'servers.dir')
+ - exo.projects.app.jboss6.version (equivalent to 'jbossas.name')
+
+
+Compatibility mode can be activated by using -Ppkg-jbossas6.
+
+
+
+
+
+== Build integration ==
+
+
+Packaging can be run separately from portal build as described before:
+
+# build portal first
+cd $GATEIN/portal/trunk
+mvn clean install -DskipTests
+
+# then package
+cd packaging/jboss-as6
+mvn
+
+
+Or it can be run together with the portal build, by using -Ppkg-jbossas6 compatibility
mode:
+
+# build and package all at once
+cd $GATEIN/portal/trunk
+mvn clean install -Ppkg-jbossas6,download -DskipTests
-Dexo.projects.directory.dependencies=$GATEIN/portal/trunk/packaging/servers
+
+(Notice how we also activate 'download' profile in this example - that's
ideal for a new user who's building GateIn for the first time)
+
+
+
+
+
+== Troubleshoot ==
+
+
+1) 'Checksum validation failed!'
+
+When using -Pdownload it may happen that the download is interrupted, and the resulting
file corrupt.
+The solution is to manually delete the target file from the filesystem, and run 'mvn
-Pdownload' again.
+
+2) 'DIRECTORY does not exist.' when using -Pdownload.
+
+When using -Pdownload, and specifying -Djbossas.name=NAME at the same time (something
you're adviced not to practice),
+the download part of the build will completely ignore 'jbossas.name' property,
but the packaging part will use it, and look for
+JBoss AS instance in the specified directory.
+The solution is to not specify -Djbossas.name=NAME at all, or to set its value to
'jboss-6.0.0.Final'.
+
+3) 'Destination JBossAS directory exists already: DIRECTORY'
+
+When using -Pdownload the downloaded JBoss AS distribution is unpacked into a local
directory. If the directory exists already
+the build will abort, to avoid corrupting a possibly carefully prepared specially
configured JBoss AS instance.
+One solution is to not use -Pdownload in this case since the appropriate JBoss AS is
already present. Or, you can move the
+directory out of the way, or delete it.
+