summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--maven-plugins/trunk/maven-zip-plugin/README25
1 files changed, 21 insertions, 4 deletions
diff --git a/maven-plugins/trunk/maven-zip-plugin/README b/maven-plugins/trunk/maven-zip-plugin/README
index dfe71b51ab..67fb9c1319 100644
--- a/maven-plugins/trunk/maven-zip-plugin/README
+++ b/maven-plugins/trunk/maven-zip-plugin/README
@@ -1,6 +1,19 @@
This module is a Maven plugin which supports using a packaging of zip in a pom.xml to
create a zip format SCA contribution.
+The main difference between an SCA zip and jar contribution is that a zip contribution supports
+nesting jar's within the zip and having those nested jar's available within the classloader
+of the contribution. This enables packaging application classes and any 3rd party jars they
+depend on together in one contribution.
+
+The zip plugin builds a zip archive of the project and includes any dependency jars used by
+the project inside the zip in a folder name "lib"
+
+TODOs:
+- make the "lib/" folder where the dependent jars go configurable
+- make which dependencies get included configurable
+ (currently its those with compile or runtime scope)
+
An example pom.xml:
<packaging>zip</packaging>
...
@@ -16,10 +29,17 @@ An example pom.xml:
</plugins>
</build>
+
+-----------------------------------------------------------------------------
This Tuscany module includes much code copied from the Maven WAR plugin 2.0.2
written by the Apache Maven team.
+-----------------------------------------------------------------------------
+
-To build, from the top maven-zip-plugin directory run maven:
+Building and releasing the plugin
+---------------------------------
+
+From the top maven-zip-plugin directory run maven:
mvn
@@ -76,6 +96,3 @@ After a successfule vote copy the staging artifacts to the live repository, eg:
cp -p -v -R maven-zip-plugin-alpha1/org/apache/tuscany/maven/plugins/ /x1/www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/tuscany/maven/plugins
-
-
-