7803d5857f
o added documentation for goals added (no new properties at this point)
o added description in jelly for some goals
o added change log information for the following commit:
http://svn.apache.org/viewcvs.cgi?rev=151648&view=rev
todos ...
o this issue is far from closed needs some more like properties for controling
the documentation rounded up for distros - some of this has already been done
by Phil Steitz in a patch
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@151694 13f79535-47bb-0310-9956-ffa450edef68
174 lines
5.5 KiB
XML
174 lines
5.5 KiB
XML
<?xml version="1.0"?>
|
|
<!--
|
|
/*
|
|
* Copyright 2001-2004 The Apache Software Foundation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
-->
|
|
|
|
<document>
|
|
|
|
<properties>
|
|
<title>Maven Distribution Plug-in Goals</title>
|
|
<author email="dion@multitask.com.au">dIon Gillard</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<goals>
|
|
<goal>
|
|
<name>dist</name>
|
|
<description>
|
|
This is the default goal of the plugin and simply attains
|
|
the <code>dist:build</code> goal.
|
|
</description>
|
|
</goal>
|
|
<goal>
|
|
<name>dist:build</name>
|
|
<description>
|
|
This goal builds a complete distribution. It is achieved by
|
|
attaining the <code>dist:build-bin</code> and
|
|
<code>dist:build-src</code> goals.
|
|
</description>
|
|
</goal>
|
|
<goal>
|
|
<name>dist:build-bin</name>
|
|
<description>
|
|
Build a binary distribution made up of
|
|
<ul>
|
|
<li>a <code>.tar.gz</code> file</li>
|
|
<li>a <code>.zip</code> file</li>
|
|
</ul>
|
|
The contents of which come from the <code>maven.dist.bin.archive.dir</code>
|
|
directory.
|
|
</description>
|
|
</goal>
|
|
<goal>
|
|
<name>dist:build-setup</name>
|
|
<description>
|
|
Creates the <code>maven.dist.dir</code> directory.
|
|
</description>
|
|
</goal>
|
|
<goal>
|
|
<name>dist:build-src</name>
|
|
<description>
|
|
Build a source distribution made up of
|
|
<ul>
|
|
<li>a <code>.tar.gz</code> file</li>
|
|
<li>a <code>.zip</code> file</li>
|
|
</ul>
|
|
The contents of which come from the <code>maven.dist.src.archive.dir</code>
|
|
directory.
|
|
</description>
|
|
</goal>
|
|
<goal>
|
|
<name>dist:deploy</name>
|
|
<description>
|
|
Deploys both source and binary distributions to the remote repository. The distribution
|
|
is packaged as the file <code>distributions.tar.gz</code>. To create
|
|
this file the <code>dist:build</code> goal is attained.
|
|
</description>
|
|
</goal>
|
|
<goal>
|
|
<name>dist:deploy-snapshot</name>
|
|
<description>
|
|
Simply attains the <code>dist:deploy</code> goal after setting
|
|
the build name to a snapshot format.
|
|
</description>
|
|
</goal>
|
|
<goal>
|
|
<name>dist:deploy-bin</name>
|
|
<description>
|
|
Deploys a binary distribution to the remote repository.
|
|
To create this file the <code>dist:build-bin</code> goal is attained.
|
|
</description>
|
|
</goal>
|
|
<goal>
|
|
<name>dist:deploy-src</name>
|
|
<description>
|
|
Deploys a source distribution to the remote repository.
|
|
To create this file the <code>dist:build-src</code> goal is attained.
|
|
</description>
|
|
</goal>
|
|
<goal>
|
|
<name>dist:prepare-bin-filesystem</name>
|
|
<description>
|
|
This goal sets up the file system in preparation of the
|
|
binary distribution. It's prerequisites are the
|
|
<code>jar:jar</code> and <code>javadoc:generate</code> goals.
|
|
</description>
|
|
</goal>
|
|
<goal>
|
|
<name>dist:prepare-src-filesystem</name>
|
|
<description>
|
|
This goal sets up the file system in preparation of the
|
|
source distribution.
|
|
</description>
|
|
</goal>
|
|
|
|
<!-- Multiproject Goals -->
|
|
|
|
<goal>
|
|
<name>dist:multiproject-deploy</name>
|
|
<description>
|
|
Top level goal that builds the source and binary distributions for
|
|
a multiproject configuration and deploys them.
|
|
</description>
|
|
</goal>
|
|
|
|
<goal>
|
|
<name>dist:multiproject-deploy-bin</name>
|
|
<description>
|
|
Builds the binary distributions (tarball and zip) for a multiproject
|
|
configuration and deploys them. All artifacts from subordinate
|
|
projects are collected, and all javadocs are assembled in a single
|
|
place.
|
|
</description>
|
|
</goal>
|
|
|
|
<goal>
|
|
<name>dist:multiproject-deploy-src</name>
|
|
<description>
|
|
Builds the source distributions (tarball and zip) for a multiproject
|
|
configuration and deploys them.
|
|
</description>
|
|
</goal>
|
|
|
|
<goal>
|
|
<name>dist:multiproject-bin</name>
|
|
<description>
|
|
Builds the binary distribution for a multiproject configuration by
|
|
gathering all artifacts and consolidating the javadocs of subordinate
|
|
projects.
|
|
</description>
|
|
</goal>
|
|
|
|
<goal>
|
|
<name>dist:multiproject-src</name>
|
|
<description>
|
|
Assembles the source distributions for a mutliproject configuration.
|
|
</description>
|
|
</goal>
|
|
|
|
<goal>
|
|
<name>dist:multiproject</name>
|
|
<description>
|
|
Top level goal used to build the distributions for a multiproject
|
|
configuration. Both the binary and source distributions are built.
|
|
</description>
|
|
</goal>
|
|
|
|
</goals>
|
|
</body>
|
|
</document>
|