2005-12-06 21:59:02 +00:00

154 lines
5.8 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* 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 Plugin Plugin Goals</title>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
<body>
<goals>
<goal>
<name>plugin:plugin</name>
<description>
Build a plugin jar. <strong>Requires at least maven 1.1 and
maven-artifact-plugin 1.7.</strong>
</description>
</goal>
<goal>
<name>plugin:download</name>
<description>
Download and install plugin from the remote repos.
Must provide groupId, artifactId and version variables.
You will be prompted for any that are omitted.
</description>
</goal>
<goal>
<name>plugin:download-artifact</name>
<description>
Download plugin from the remote repos.
Must provide groupId, artifactId and version variables.
You will be prompted for any that are omitted.
</description>
</goal>
<goal>
<name>plugin:generate-docs</name>
<description>Generate navigation, goals, properties and tags docs</description>
</goal>
<goal>
<name>plugin:generate-goals</name>
<description>Generate goals.xml for the plugin</description>
</goal>
<goal>
<name>plugin:generate-navigation</name>
<description>Generate navigation.xml for the plugin</description>
</goal>
<goal>
<name>plugin:generate-properties</name>
<description>Generate properties.xml for the plugin</description>
</goal>
<goal>
<name>plugin:generate-tags</name>
<description>Generate tags.xml skeleton for any jelly taglibs included in the plugin</description>
</goal>
<goal>
<name>plugin:install</name>
<description>
Build and install the current plugin in
<code>${maven.plugin.dir}</code>.
This calls <code>plugin:plugin</code> and therefore
<strong>requires at least maven 1.1 and maven-artifact-plugin 1.7.
</strong>
</description>
</goal>
<goal>
<name>plugin:install-now</name>
<description>
Install the plugin into the current Maven instance.
It is also installed into the user's plugin cache so that it will be available to
that user on subsequent Maven invocations.
This calls <code>plugin:plugin</code> and therefore
<strong>requires at least maven 1.1 and maven-artifact-plugin 1.7.
</strong>
</description>
</goal>
<goal>
<name>plugin:uninstall</name>
<description>Uninstall all versions of the plugin from Maven's plugins dir</description>
</goal>
<goal>
<name>plugin:uninstall-now</name>
<description>
Uninstall the plugin from the current Maven instance.
It is also uninstalled from the user's plugin cache and the global Maven installation.
</description>
</goal>
<goal>
<name>plugin:test</name>
<description>
Run a plugin's test project by executing maven with a goal called
<code>testPlugin</code> in <code>${maven.plugin.test.dir}</code>.
This directory should contain a <code>project.xml</code> project
descriptor and a custom <code>maven.xml</code> file that
defines the goal.
</description>
</goal>
<goal>
<name>plugin:repository-install</name>
<description>
Install the current plugin version to the local repository.
This calls <code>plugin:plugin</code> and therefore
<strong>requires at least maven 1.1 and maven-artifact-plugin 1.7.
</strong>
</description>
</goal>
<goal>
<name>plugin:repository-install-snapshot</name>
<description>
Install a snapshot build of the plugin to the local repository.
<strong>DEPRECATED</strong>: use <code>plugin:repository-install</code> with
<code>-SNAPSHOT</code> in the project version for equivalent behaviour.
</description>
</goal>
<goal>
<name>plugin:repository-deploy</name>
<description>
Deploy the current plugin version to the remote repository.
This uses the <a href="../artifact/index.html">Artifact plugin</a> to
do the deployment, so properties need to be set up as per that plugin.
This calls <code>plugin:plugin</code> and therefore
<strong>requires at least maven 1.1 and maven-artifact-plugin 1.7.
</strong>
</description>
</goal>
<goal>
<name>plugin:repository-deploy-snapshot</name>
<description>
Deploy a snapshot build of the plugin to the remote repository.
This uses the <a href="../artifact/index.html">Artifact plugin</a> to
do the deployment, so properties need to be set up as per that plugin.
<strong>DEPRECATED</strong>: use <code>plugin:repository-deploy</code> with
<code>-SNAPSHOT</code> in the project version for equivalent behaviour.
</description>
</goal>
</goals>
</body>
</document>