Author: aramirez
Date: Wed Feb 22 00:50:49 2006
New Revision: 379731
URL: http://svn.apache.org/viewcvs?rev=379731&view=rev
Log:
PR: MDEPLOY-24
Submitted By: Jerome Lacoste
Reviewed by: Allan Ramirez
- added howto and introduction documentation
Added:
maven/plugins/trunk/maven-deploy-plugin/src/site/
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/howto.apt
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/introduction.apt
maven/plugins/trunk/maven-deploy-plugin/src/site/site.xml
Added: maven/plugins/trunk/maven-deploy-plugin/src/site/apt/howto.apt
URL:
http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-deploy-plugin/src/site/apt/howto.apt?rev=379731&view=auto
==============================================================================
--- maven/plugins/trunk/maven-deploy-plugin/src/site/apt/howto.apt (added)
+++ maven/plugins/trunk/maven-deploy-plugin/src/site/apt/howto.apt Wed Feb 22
00:50:49 2006
@@ -0,0 +1,41 @@
+ ------
+ Maven 2 Deploy Plugin
+ ------
+ Jerome Lacoste
+ ------
+ January 29 2006
+ ------
+
+How-to
+
+
+
+deploy:deploy
+
+ If you've configured your repository deployment information correctly (in
the pom and in your settings.xml), most of the time, deploying will only
require to run
+
+-------------------------------
+mvn deploy
+-------------------------------
+
+
+deploy:deploy-file
+
+-------------------------------
+mvn deploy:deploy-file -Durl=file://C:\m2-repo -DrepositoryId
-Dfile=thefile.jar
+ [-DpomFile=the.pom]
+ [-DgroupId=group] [-DartifactId=artifact]
[-Dversion=version] [-Dpackaging]
+ [-Dclassifier=test]
+ [-DgeneratePom=true]
+-------------------------------
+
+ If the following required information is not specified in some way, the goal
will fail:
+
+ * the file to deploy
+
+ * the group, artifact, version and packaging of the file to deploy. These
can be taken from the specified pomFile, and overriden or specified using the
command line. When the pomFile contains a <parent> section, the parent's
groupId can be considered if the groupId is not specified further for the
current project or on the command line.
+
+ * the repository information: the url to deploy to and the repositoryId
mapping to a server section in the settings.xml file.
+
+ Optionally, one can specify a classifier, or avoid generating a pom.
+
Added: maven/plugins/trunk/maven-deploy-plugin/src/site/apt/introduction.apt
URL:
http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-deploy-plugin/src/site/apt/introduction.apt?rev=379731&view=auto
==============================================================================
--- maven/plugins/trunk/maven-deploy-plugin/src/site/apt/introduction.apt
(added)
+++ maven/plugins/trunk/maven-deploy-plugin/src/site/apt/introduction.apt Wed
Feb 22 00:50:49 2006
@@ -0,0 +1,47 @@
+ ------
+ Maven 2 Deploy Plugin
+ ------
+ Jerome Lacoste
+ ------
+ January 29 2006
+ ------
+
+Introduction
+
+ The deploy plugin is primarily used during the deploy phase, to add your
artifact(s) to a remote repository for sharing with other developers and
projects. This is usualy done in an integration or release environment. It can
also be used to deploy a particular artifact (e.g. a third party jar like Sun's
non redistributable reference implementations).
+
+ As a repository contains more than the artifacts (POMs, the metadata, MD5
and SHA1 hash files...), deploying means not only copying the artifacts, but
making sure all this information is correctly updated. It's the reponsibility
of the deploy plugin.
+
+ To work, the deployment will require:
+
+ * information about the repository: its location, the transport method used
to access it (FTP, SCP, SFTP...) and the optional user specific required
account information
+
+ * information about the artifact(s): the group, artifact, version,
packaging, classifier...
+
+ * a deployer: a method to actually perform the deployment. This can be
implemented as a wagon transport (making it cross-platform), or use a system
specific method.
+
+ The information will be taken from the implied (or specified) pom and from
the command line. The settings.xml file may also be parsed to retrieve user
credentials.
+
+
+Goals overview
+
+ The deploy plugin has 2 goals:
+
+ * {{{index.html} deploy:deploy}} is used to automatically install the
artifact, its pom and the attached artifacts produced by a particuliar project.
Most if not all the information related to the deployment is stored in the
project's pom. The operation
+
+ * {{{index.html} deploy:deploy-file}} is used to install a single artifact
along with its pom. In that case the artifact information can be taken from an
optionally specified pomFile, but can be completed/overriden using the command
line.
+
+
+Links
+
+ *
{{{http://maven.apache.org/guides/introduction/introduction-to-repositories.html}
Introduction to repositories}}
+
+ *
{{{http://maven.apache.org/guides/mini/guide-deploying-3rd-party-jars.html}
Guide to deploying 3rd party jars to remote repository}}
+
+ * {{{http://maven.apache.org/guides/mini/guide-deploy-ftp.html} Guide to
deployment using FTP}}
+
+ * {{{http://maven.apache.org/guides/mini/guide-deploy-ssh-external.html}
Guide to deployment using an external SSH}}
+
+ *
{{{http://maven.apache.org/guides/mini/guide-deployment-security-settings.html}
Security and Deployment Settings}}
+
+ * {{{http://maven.apache.org/guides/index.html} Maven guides}}
\ No newline at end of file
Added: maven/plugins/trunk/maven-deploy-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-deploy-plugin/src/site/site.xml?rev=379731&view=auto
==============================================================================
--- maven/plugins/trunk/maven-deploy-plugin/src/site/site.xml (added)
+++ maven/plugins/trunk/maven-deploy-plugin/src/site/site.xml Wed Feb 22
00:50:49 2006
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+/*
+ * Copyright 2001-2005 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.
+ */
+-->
+
+<project name="Maven Deploy Plug-In">
+ <bannerLeft>
+ <name>Mojo</name>
+ <src>http://maven.apache.org/images/apache-maven-project.png</src>
+ <href>http://maven.apache.org/</href>
+ </bannerLeft>
+ <bannerRight>
+ <name>Codehaus</name>
+ <src>http://maven.apache.org/images/maven-small.gif</src>
+ </bannerRight>
+ <body>
+ <links>
+ <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
+ </links>
+
+ <menu name="Overview">
+ <item name="Plugin Goals" href="index.html"/>
+ <item name="Introduction" href="introduction.html"/>
+ <item name="How to Use" href="howto.html"/>
+ <item name="Javadoc" href="apidocs/index.html"/>
+ </menu>
+ ${reports}
+ </body>
+</project>
\ No newline at end of file
