blob: 81515002dfe7559f59dd5906d051248a9a111365 [file] [log] [blame]
Jerome Lacoste
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership. The ASF licenses this file
~~ to you 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
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ KIND, either express or implied. See the License for the
~~ specific language governing permissions and limitations
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
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 usually 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,
* 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
* Goals Overview
The deploy plugin has 2 goals:
* {{{./deploy-mojo.html}deploy:deploy}} is used to automatically install the
artifact, its pom and the attached artifacts produced by a particular
project. Most if not all of the information related to the deployment is stored
in the project's pom.
* {{{./deploy-file-mojo.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.
* Major Version Upgrade to version 3.0.0
Please note that the following parameter has been completely removed from the plugin configuration:
* uniqueVersion
* The syntax of the following parameters for the plugin has been changed:
* altDeploymentRepository
* altReleaseDeploymentRepository
* altSnapshotDeploymentRepository
The old format was: <<<id::layout::url>>>
The new format is: <<<id::url>>>
As of Maven 3, snapshot artifacts will always be deployed using a timestamped version.
* Usage
General instructions on how to use the Deploy Plugin can be found on the {{{./usage.html}usage page}}. Some more
specific use cases are described in the examples given below.
In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
the {{{./mailing-lists.html}mail archive}}.
If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
{{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project from our
{{{./scm.html}source repository}} and will find supplementary information in the
{{{}guide to helping with Maven}}.
* Examples
To provide you with better understanding on some usages of the deploy plugin,
you can take a look into the following examples:
<Project Deployment:>
* {{{./examples/deploy-ftp.html}Deployment with FTP}}
* {{{./examples/deploy-ssh-external.html}Deployment with external SSH}}
* {{{./examples/deploy-network-issues.html}Workarounds when there are network issues}}
<File Deployment:>
* {{{./examples/disabling-generic-pom.html}Disable the generation of pom}}
* {{{./examples/deploying-with-customized-pom.html}Deploy an artifact with a customized pom}}
* {{{./examples/deploying-with-classifiers.html}Deploy an artifact with classifier}}
* {{{./examples/deploying-in-legacy-layout.html}Deploy an artifact in legacy layout}}