| 1 |
------ |
| 2 |
Introduction |
| 3 |
------ |
| 4 |
Jerome Lacoste |
| 5 |
------ |
| 6 |
2013-07-22 |
| 7 |
------ |
| 8 |
|
| 9 |
~~ Licensed to the Apache Software Foundation (ASF) under one |
| 10 |
~~ or more contributor license agreements. See the NOTICE file |
| 11 |
~~ distributed with this work for additional information |
| 12 |
~~ regarding copyright ownership. The ASF licenses this file |
| 13 |
~~ to you under the Apache License, Version 2.0 (the |
| 14 |
~~ "License"); you may not use this file except in compliance |
| 15 |
~~ with the License. You may obtain a copy of the License at |
| 16 |
~~ |
| 17 |
~~ http://www.apache.org/licenses/LICENSE-2.0 |
| 18 |
~~ |
| 19 |
~~ Unless required by applicable law or agreed to in writing, |
| 20 |
~~ software distributed under the License is distributed on an |
| 21 |
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 22 |
~~ KIND, either express or implied. See the License for the |
| 23 |
~~ specific language governing permissions and limitations |
| 24 |
~~ under the License. |
| 25 |
|
| 26 |
~~ NOTE: For help with the syntax of this file, see: |
| 27 |
~~ http://maven.apache.org/doxia/references/apt-format.html |
| 28 |
|
| 29 |
${project.name} |
| 30 |
|
| 31 |
The deploy plugin is primarily used during the deploy phase, to add your |
| 32 |
artifact(s) to a remote repository for sharing with other developers and |
| 33 |
projects. This is usually done in an integration or release environment. It can |
| 34 |
also be used to deploy a particular artifact (e.g. a third party jar like |
| 35 |
Sun's non redistributable reference implementations). |
| 36 |
|
| 37 |
As a repository contains more than the artifacts (POMs, the metadata, MD5 and |
| 38 |
SHA1 hash files...), deploying means not only copying the artifacts, but |
| 39 |
making sure all this information is correctly updated. It's the reponsibility |
| 40 |
of the deploy plugin. |
| 41 |
|
| 42 |
To work, the deployment will require: |
| 43 |
|
| 44 |
* information about the repository: its location, the transport method used to |
| 45 |
access it (FTP, SCP, SFTP...) and the optional user specific required |
| 46 |
account information |
| 47 |
|
| 48 |
* information about the artifact(s): the group, artifact, version, packaging, |
| 49 |
classifier... |
| 50 |
|
| 51 |
* a deployer: a method to actually perform the deployment. This can be |
| 52 |
implemented as a wagon transport (making it cross-platform), or use a system |
| 53 |
specific method. |
| 54 |
|
| 55 |
[] |
| 56 |
|
| 57 |
The information will be taken from the implied (or specified) pom and from the |
| 58 |
command line. The settings.xml file may also be parsed to retrieve user |
| 59 |
credentials. |
| 60 |
|
| 61 |
|
| 62 |
* Goals Overview |
| 63 |
|
| 64 |
The deploy plugin has 2 goals: |
| 65 |
|
| 66 |
* {{{./deploy-mojo.html}deploy:deploy}} is used to automatically install the |
| 67 |
artifact, its pom and the attached artifacts produced by a particular |
| 68 |
project. Most if not all of the information related to the deployment is stored |
| 69 |
in the project's pom. |
| 70 |
|
| 71 |
* {{{./deploy-file-mojo.html}deploy:deploy-file}} is used to install a single artifact |
| 72 |
along with its pom. In that case the artifact information can be taken from |
| 73 |
an optionally specified pomFile, but can be completed/overriden using the |
| 74 |
command line. |
| 75 |
|
| 76 |
[] |
| 77 |
|
| 78 |
* Usage |
| 79 |
|
| 80 |
General instructions on how to use the Deploy Plugin can be found on the {{{./usage.html}usage page}}. Some more |
| 81 |
specific use cases are described in the examples given below. |
| 82 |
|
| 83 |
In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel |
| 84 |
free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could |
| 85 |
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching |
| 86 |
the {{{./mailing-lists.html}mail archive}}. |
| 87 |
|
| 88 |
If you feel like the plugin is missing a feature or has a defect, you can file a feature request or bug report in our |
| 89 |
{{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your |
| 90 |
concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, |
| 91 |
entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. |
| 92 |
Of course, patches are welcome, too. Contributors can check out the project from our |
| 93 |
{{{./scm.html}source repository}} and will find supplementary information in the |
| 94 |
{{{https://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}. |
| 95 |
|
| 96 |
* Examples |
| 97 |
|
| 98 |
To provide you with better understanding on some usages of the deploy plugin, |
| 99 |
you can take a look into the following examples: |
| 100 |
|
| 101 |
<Project Deployment:> |
| 102 |
|
| 103 |
* {{{./examples/deploy-ftp.html}Deployment with FTP}} |
| 104 |
|
| 105 |
* {{{./examples/deploy-ssh-external.html}Deployment with external SSH}} |
| 106 |
|
| 107 |
* {{{./examples/deploy-network-issues.html}Workarounds when there are network issues}} |
| 108 |
|
| 109 |
[] |
| 110 |
|
| 111 |
<File Deployment:> |
| 112 |
|
| 113 |
* {{{./examples/disabling-generic-pom.html}Disable the generation of pom}} |
| 114 |
|
| 115 |
* {{{./examples/deploying-with-customized-pom.html}Deploy an artifact with a customized pom}} |
| 116 |
|
| 117 |
* {{{./examples/deploying-with-classifiers.html}Deploy an artifact with classifier}} |
| 118 |
|
| 119 |
* {{{./examples/deploying-in-legacy-layout.html}Deploy an artifact in legacy layout}} |
| 120 |
|
| 121 |
[] |