Author: aramirez
Date: Tue Jul 4 07:16:09 2006
New Revision: 419013
URL: http://svn.apache.org/viewvc?rev=419013&view=rev
Log:
PR: MDEPLOY-35
-improved docs
-moved samples to /examples
-moved guide to ftp deploy to examples
-moved guide to ssh external deploy to examples
Added:
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploy-ftp.apt
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploy-ssh-external.apt
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-in-legacy-layout.apt
- copied, changed from r418931,
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/deploying-in-legacy-layout.apt
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-with-classifiers.apt
- copied, changed from r418931,
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/deploying-with-classifiers.apt
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-with-customed-pom.apt
- copied, changed from r418931,
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/deploying-with-customed-pom.apt
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/disabling-generic-pom.apt
- copied, changed from r418931,
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/disabling-generic-pom.apt
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/disabling-timestamps-suffix.apt
- copied, changed from r418931,
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/disabling-timestamps-suffix.apt
Removed:
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/
Modified:
maven/plugins/trunk/maven-deploy-plugin/pom.xml
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/faq.apt
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/overview.apt
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-deploy-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-deploy-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/pom.xml?rev=419013&r1=419012&r2=419013&view=diff
==============================================================================
--- maven/plugins/trunk/maven-deploy-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-deploy-plugin/pom.xml Tue Jul 4 07:16:09 2006
@@ -10,6 +10,25 @@
<name>Maven Deploy Plugin</name>
<version>2.2.2-SNAPSHOT</version>
<inceptionYear>2004</inceptionYear>
+ <prerequisites>
+ <maven>2.0</maven>
+ </prerequisites>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jxr-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changelog-plugin</artifactId>
+ </plugin>
+ </plugins>
+ </reporting>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
Added:
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploy-ftp.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploy-ftp.apt?rev=419013&view=auto
==============================================================================
---
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploy-ftp.apt
(added)
+++
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploy-ftp.apt
Tue Jul 4 07:16:09 2006
@@ -0,0 +1,87 @@
+ ------
+ Maven 2 Deploy Plugin
+ ------
+ Jason van Zyl
+ ------
+ 12 October 2005
+ ------
+
+Deployment of artifacts with FTP
+
+ In order to deploy artifacts using FTP you must first specify the use of an
FTP server in the
+ <<distributionManagement>> element of your POM as well as specifying an
<<<extension>>> in your
+ <<<build>>> element which will pull in the FTP artifacts required to deploy
with FTP:
+
++----+
+<project>
+ <parent>
+ <groupId>com.stchome</groupId>
+ <artifactId>mavenFull</artifactId>
+ <version>1.0</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>com.mycompany</groupId>
+ <artifactId>my-app</artifactId>
+ <packaging>jar</packaging>
+ <version>1.1-SNAPSHOT</version>
+ <name>Maven Quick Start Archetype</name>
+ <url>http://maven.apache.org</url>
+ <dependencies>
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>3.8.1</version>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+
+ <!-- Enabling the use of FTP -->
+ <distributionManagement>
+ <repository>
+ <id>ftp-repository</id>
+ <url>ftp://repository.mycompany.com/repository</url>
+ </repository>
+ </distributionManagement>
+
+ <build>
+ <extensions>
+ <extension>
+ <groupId>org.apache.maven.wagon</groupId>
+ <artifactId>wagon-ftp</artifactId>
+ <version>1.0-alpha-6</version>
+ </extension>
+ </extensions>
+ </build>
+
+</project>
++----+
+
+ Your <<<settings.xml>>> would contain a <<<server>>> element where the
<<<id>>> of that element matches <<<id>>> of the
+ FTP repository specified in the POM above:
+
++----+
+<settings>
+
+ ...
+
+ <servers>
+ <server>
+ <id>ftp-repository</id>
+ <username>user</username>
+ <password>pass</password>
+ </server>
+
+ </servers>
+
+ ...
+
+</settings>
++----+
+
+ You should, of course, make sure that you can login into the specified FTP
server by hand before attempting the
+ deployment with Maven. Once you have verified that everything is setup
correctly you can now deploy your artifacts
+ using Maven:
+
++----+
+mvn deploy
++----+
\ No newline at end of file
Added:
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploy-ssh-external.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploy-ssh-external.apt?rev=419013&view=auto
==============================================================================
---
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploy-ssh-external.apt
(added)
+++
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploy-ssh-external.apt
Tue Jul 4 07:16:09 2006
@@ -0,0 +1,126 @@
+ ------
+ Maven 2 Deploy Plugin
+ ------
+ Jason van Zyl
+ ------
+ 12 October 2005
+ ------
+
+Deployment of artifacts in an external SSH command
+
+ In order to deploy artifacts using SSH you must first specify the use of an
SSH server in the
+ <<distributionManagement>> element of your POM as well as specifying an
<<<extension>>> in your
+ <<<build>>> element which will pull in the SSH artifacts required to deploy
with SSH:
+
++----+
+
+<project>
+ <parent>
+ <groupId>com.stchome</groupId>
+ <artifactId>mavenFull</artifactId>
+ <version>1.0</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>com.mycompany</groupId>
+ <artifactId>my-app</artifactId>
+ <packaging>jar</packaging>
+ <version>1.1-SNAPSHOT</version>
+ <name>Maven Quick Start Archetype</name>
+ <url>http://maven.apache.org</url>
+ <dependencies>
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>3.8.1</version>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+
+ <!-- Enabling the use of FTP -->
+ <distributionManagement>
+ <repository>
+ <id>ssh-repository</id>
+ <url>scpexe://repository.mycompany.com/repository</url>
+ </repository>
+ </distributionManagement>
+
+ <build>
+ <extensions>
+ <extension>
+ <groupId>org.apache.maven.wagon</groupId>
+ <artifactId>wagon-ssh-external</artifactId>
+ <version>1.0-alpha-5</version>
+ </extension>
+ </extensions>
+ </build>
+
+</project>
+
++----+
+
+ If you are deploying from Unix or have Cygwin installed you won't need to any
additional configuration in your <<<settings.xml>>>
+ file as everything will be taken from the environment. But if you are on
Windows and are using something like <<<plink>>> then
+ you will need something like the following:
+
++----+
+
+<settings>
+ ...
+ <servers>
+ <server>
+ <id>ssh-repository</id>
+ <username>your username in the remote system if different from
local</username>
+ <privateKey>/path/to/your/private/key</privateKey> <!-- not needed if
using pageant -->
+ <configuration>
+ <sshExecutable>plink</sshExecutable>
+ <scpExecutable>pscp</scpExecutable>
+ <sshArgs>other arguments you may need</sshArgs>
+ </configuration>
+ </server>
+ </servers>
+ ...
+</settings>
+
++----+
+
+ You should, of course, make sure that you can login into the specified SSH
server by hand before attempting the
+ deployment with Maven. Once you have verified that everything is setup
correctly you can now deploy your artifacts
+ using Maven:
+
++----+
+
+mvn deploy
+
++----+
+
+ Sometimes you may have permissions problems deploying and if so you can set
the file and directory permissions
+ like so:
+
++----+
+
+ <settings>
+ ...
+ <servers>
+ <server>
+ <id>ssh-repository</id>
+ <!--
+ |
+ | Change default file/dir permissions
+ |
+ -->
+ <filePermissions>664</filePermissions>
+ <directoryPermissions>775</directoryPermissions>
+ <configuration>
+ <sshExecutable>plink</sshExecutable>
+ <scpExecutable>pscp</scpExecutable>
+ </configuration>
+ </server>
+ </servers>
+ ...
+ </settings>
+
++----+
+
+ <<NOTE:>> If you are using Putty it will expect the private key to be in the
<<<PPK>>> format and not the standard
+ format so make sure you use <<<puttygen>>> to convert your openssh format key
to <<<PPK>>> format or generate another
+ one. Windows users can find the Putty tools
{{{http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html}here}}.
Copied:
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-in-legacy-layout.apt
(from r418931,
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/deploying-in-legacy-layout.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-in-legacy-layout.apt?p2=maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-in-legacy-layout.apt&p1=maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/deploying-in-legacy-layout.apt&r1=418931&r2=419013&rev=419013&view=diff
==============================================================================
---
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/deploying-in-legacy-layout.apt
(original)
+++
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-in-legacy-layout.apt
Tue Jul 4 07:16:09 2006
@@ -6,7 +6,7 @@
June 2006
------
-Deploying the artifact in a legacy layout of repository
+Deploy an artifact in legacy layout
"Legacy" is the layout used in maven 1 repositories while maven 2 uses
"default". They are different
in terms of directory structure, timestamp of snapshots in default and
existence of metadata files in default.
@@ -15,26 +15,19 @@
+---+
groupId
- |
- +--artifactId
- |
- +--jars
- |
- +--artifact
+ |--artifactId
+ |--jars
+ `--artifact
+---+
* default layout directory structure:
+---+
groupId
- |
- +--artifactId
- |
- +--version
- | |
- | ---artifact
- |
- ---metadata
+ |--artifactId
+ |--version
+ | `---artifact
+ |---metadata
+---+
In able to deploy an artifact in a legacy layout
Copied:
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-with-classifiers.apt
(from r418931,
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/deploying-with-classifiers.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-with-classifiers.apt?p2=maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-with-classifiers.apt&p1=maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/deploying-with-classifiers.apt&r1=418931&r2=419013&rev=419013&view=diff
==============================================================================
---
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/deploying-with-classifiers.apt
(original)
+++
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-with-classifiers.apt
Tue Jul 4 07:16:09 2006
@@ -6,7 +6,7 @@
June 2006
------
-Deploying an artifact with classifiers
+Deploy an artifact with classifier
Classifiers are the additional text given to describe an artifact.
Copied:
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-with-customed-pom.apt
(from r418931,
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/deploying-with-customed-pom.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-with-customed-pom.apt?p2=maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-with-customed-pom.apt&p1=maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/deploying-with-customed-pom.apt&r1=418931&r2=419013&rev=419013&view=diff
==============================================================================
---
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/deploying-with-customed-pom.apt
(original)
+++
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deploying-with-customed-pom.apt
Tue Jul 4 07:16:09 2006
@@ -6,7 +6,7 @@
June 2006
------
-Deploying an artifact together with a customed pom
+Deploy an artifact with a customed pom
If there is already an existing pom and want it to be deployed together with
the 3rd party artifact,
set the <<pomFile>> parameter to the path of the pom.xml.
Copied:
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/disabling-generic-pom.apt
(from r418931,
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/disabling-generic-pom.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/disabling-generic-pom.apt?p2=maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/disabling-generic-pom.apt&p1=maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/disabling-generic-pom.apt&r1=418931&r2=419013&rev=419013&view=diff
==============================================================================
---
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/disabling-generic-pom.apt
(original)
+++
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/disabling-generic-pom.apt
Tue Jul 4 07:16:09 2006
@@ -6,7 +6,7 @@
June 2006
------
-Disabling the generation of generic pom on deployment
+Disable the generation of pom
By default, If no pom is specified during deployment of your 3rd party
artifact, a generic pom will be generated
which contains the minimum required elements needed for the pom. In order to
disable it, set the
Copied:
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/disabling-timestamps-suffix.apt
(from r418931,
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/disabling-timestamps-suffix.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/disabling-timestamps-suffix.apt?p2=maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/disabling-timestamps-suffix.apt&p1=maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/disabling-timestamps-suffix.apt&r1=418931&r2=419013&rev=419013&view=diff
==============================================================================
---
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/deployfile/disabling-timestamps-suffix.apt
(original)
+++
maven/plugins/trunk/maven-deploy-plugin/src/site/apt/examples/disabling-timestamps-suffix.apt
Tue Jul 4 07:16:09 2006
@@ -6,7 +6,7 @@
June 2006
------
-Disabling the timestamp suffixed to the deployed artifact
+Disable timestamps suffix in an artifact
By default, when a snapshot version of an artifact is deployed to a
repository, a timestamp is suffixed to it.
To disable the addition of timestamp to the artifact, set the
<<uniqueVersion>> parameter to <<<false>>>.
Modified: maven/plugins/trunk/maven-deploy-plugin/src/site/apt/faq.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/src/site/apt/faq.apt?rev=419013&r1=419012&r2=419013&view=diff
==============================================================================
--- maven/plugins/trunk/maven-deploy-plugin/src/site/apt/faq.apt (original)
+++ maven/plugins/trunk/maven-deploy-plugin/src/site/apt/faq.apt Tue Jul 4
07:16:09 2006
@@ -6,4 +6,4 @@
June 2006
------
-
+Frequently Asked Questions
Modified: maven/plugins/trunk/maven-deploy-plugin/src/site/apt/overview.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/src/site/apt/overview.apt?rev=419013&r1=419012&r2=419013&view=diff
==============================================================================
--- maven/plugins/trunk/maven-deploy-plugin/src/site/apt/overview.apt (original)
+++ maven/plugins/trunk/maven-deploy-plugin/src/site/apt/overview.apt Tue Jul
4 07:16:09 2006
@@ -51,20 +51,10 @@
an optionally specified pomFile, but can be completed/overriden using the
command line.
-* How-To
+* Usage
- Some basic instructions for configuring and using the mojos of the
<<<maven-deploy-plugin>>> can be found in the {{{howto.html}How-To guide}}.
+ Some basic instructions for configuring and using the mojos of the
<<<maven-deploy-plugin>>> can be found in the {{{usage.html}Usage}}.
-* Resources
+* Examples
- *
{{{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
+ Sample use-cases for the plugin are available under the Examples menu
\ No newline at end of file
Modified: maven/plugins/trunk/maven-deploy-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/src/site/apt/usage.apt?rev=419013&r1=419012&r2=419013&view=diff
==============================================================================
--- maven/plugins/trunk/maven-deploy-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-deploy-plugin/src/site/apt/usage.apt Tue Jul 4
07:16:09 2006
@@ -7,7 +7,7 @@
January 29 2006
------
-How-to
+Usage
* Introduction
@@ -43,13 +43,8 @@
<repository>
<id>internal.repo</id>
<name>MyCo Internal Repository</name>
- <url>scp://host.com/path/to/remote/repository</url>
+ <url>Host to Company Repository</url>
</repository>
- <snapshotRepository>
- <id>internal.repo</id>
- <name>MyCo Internal Snapshot Repository</name>
- <url>scp://host.com/path/to/snapshot/repository</url>
- </snapshotRespository>
</distributionManagement>
[...]
+---+
Modified: maven/plugins/trunk/maven-deploy-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/src/site/site.xml?rev=419013&r1=419012&r2=419013&view=diff
==============================================================================
--- maven/plugins/trunk/maven-deploy-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-deploy-plugin/src/site/site.xml Tue Jul 4
07:16:09 2006
@@ -36,13 +36,17 @@
<menu name="Plugin Overview">
<item name="Overview" href="overview.html"/>
<item name="Usage" href="usage.html"/>
+ <item name="FAQs" href="faq.html"/>
+ <!--item name="Examples" href="examples/examples.html"/-->
</menu>
- <menu name="Examples for plugin Configuration">
- <item name="Disable generic pom"
href="examples/deployfile/disabling-generic-pom.html"/>
- <item name="Deploy with customed pom"
href="examples/deployfile/deploying-with-customed-pom.html"/>
- <item name="Deploy with classifier"
href="examples/deployfile/deploying-with-classifiers.html"/>
- <item name="Disable timestamps suffix"
href="examples/deployfile/disabling-timestamps-suffix.html"/>
- <item name="Deploy in legacy"
href="examples/deployfile/deploying-in-legacy-layout.html"/>
+ <menu name="Examples">
+ <item name="Deployment with FTP" href="examples/deploy-ftp.html"/>
+ <item name="Deployment with external SSH "
href="examples/deploy-ssh-external.html"/>
+ <item name="Disable the generation of pom"
href="examples/disabling-generic-pom.html"/>
+ <item name="Deploy an artifact with a customed pom"
href="examples/deploying-with-customed-pom.html"/>
+ <item name="Deploy an artifact with classifier"
href="examples/deploying-with-classifiers.html"/>
+ <item name="Disable timestamps suffix in an artifact"
href="examples/disabling-timestamps-suffix.html"/>
+ <item name="Deploy an artifact in legacy layout"
href="examples/deploying-in-legacy-layout.html"/>
</menu>
${reports}
</body>
