Modified: websites/production/maven/content/plugins-archives/maven-deploy-plugin-LATEST/deploy-file-mojo.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-deploy-plugin-LATEST/deploy-file-mojo.html (original) +++ websites/production/maven/content/plugins-archives/maven-deploy-plugin-LATEST/deploy-file-mojo.html Wed Aug 27 20:27:59 2014 @@ -1,525 +1,788 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<!-- - | Generated by Apache Maven Doxia at Oct 19, 2013 - | Rendered using Apache Maven Stylus Skin 1.5 ---> -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <title>Apache Maven Deploy Plugin - - deploy:deploy-file</title> - <style type="text/css" media="all"> - @import url("./css/maven-base.css"); - @import url("./css/maven-theme.css"); - @import url("./css/site.css"); - </style> - <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20131019" /> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - -<script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> - -<script type="text/javascript">_uacct = "UA-140879-1"; - urchinTracker();</script> - </head> - <body class="composite"> - <div id="banner"> - <a href="../../" id="bannerLeft"> - <img src="../../images/apache-maven-project-2.png" alt="" /> - </a> - <span id="bannerRight"> - <img src="../../images/maven-logo-2.gif" alt="" /> - </span> - <div class="clear"> - <hr/> - </div> - </div> - <div id="breadcrumbs"> - - <div class="xleft"> - <a href="http://www.apache.org/"; class="externalLink">Apache</a> - > - <a href="../../index.html">Maven</a> - > - <a href="../index.html">Plugins</a> - > - <a href="./">Apache Maven Deploy Plugin</a> - > - - deploy:deploy-file - </div> - <div class="xright"> - Last Published: 2013-10-19 - | Version: 2.8.1 - </div> - <div class="clear"> - <hr/> - </div> - </div> - <div id="leftColumn"> - <div id="navcolumn"> - - <h5>Overview</h5> - <ul> - <li class="none"> - <a href="index.html">Introduction</a> - </li> - <li class="none"> - <a href="plugin-info.html">Goals</a> - </li> - <li class="none"> - <a href="usage.html">Usage</a> - </li> - <li class="none"> - <a href="faq.html">FAQ</a> - </li> - <li class="none"> - <a href="jira-report.html">Release Notes</a> - </li> - </ul> - <h5>Examples</h5> - <ul> - <li class="collapsed"> - <a href="project-deployment.html">Project Deployment</a> - </li> - <li class="collapsed"> - <a href="file-deployment.html">File Deployment</a> - </li> - </ul> - <h5>Project Documentation</h5> - <ul> - <li class="collapsed"> - <a href="project-info.html">Project Information</a> - </li> - <li class="collapsed"> - <a href="project-reports.html">Project Reports</a> - </li> - </ul> - <h5>Maven Projects</h5> - <ul> - <li class="none"> - <a href="../../ant-tasks/index.html">Ant Tasks</a> - </li> - <li class="none"> - <a href="../../archetype/index.html">Archetype</a> - </li> - <li class="none"> - <a href="../../doxia/index.html">Doxia</a> - </li> - <li class="none"> - <a href="../../jxr/index.html">JXR</a> - </li> - <li class="none"> - <a href="../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../index.html">Maven 2 & 3</a> - </li> - <li class="none"> - <a href="../../pom/index.html">Parent POMs</a> - </li> - <li class="none"> - <a href="../index.html">Plugins</a> - </li> - <li class="none"> - <a href="../../plugin-tools/index.html">Plugin Tools</a> - </li> - <li class="none"> - <a href="../../scm/index.html">SCM</a> - </li> - <li class="none"> - <a href="../../shared/index.html">Shared Components</a> - </li> - <li class="none"> - <a href="../../skins/index.html">Skins</a> - </li> - <li class="none"> - <a href="../../surefire/index.html">Surefire</a> - </li> - <li class="none"> - <a href="../../wagon/index.html">Wagon</a> - </li> - </ul> - <h5>ASF</h5> - <ul> - <li class="none"> - <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink">How Apache Works</a> - </li> - <li class="none"> - <a href="http://www.apache.org/foundation/"; class="externalLink">Foundation</a> - </li> - <li class="none"> - <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink">Sponsoring Apache</a> - </li> - <li class="none"> - <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink">Thanks</a> - </li> - </ul> - <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> - <img alt="Built by Maven" src="./images/logos/maven-feather.png"/> - </a> - - </div> - </div> - <div id="bodyColumn"> - <div id="contentBox"> - - - <div class="section"><h2>deploy:deploy-file<a name="deploy:deploy-file"></a></h2> - <p><b>Full name</b>:</p> - <p>org.apache.maven.plugins:maven-deploy-plugin:2.8.1:deploy-file</p> - <p><b>Description</b>:</p> - <div>Installs the artifact in the remote repository.</div> - <p><b>Attributes</b>:</p> - <ul> - <li>The goal is thread-safe and supports parallel builds.</li> - </ul> - <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3> - <table class="bodyTable" border="0"> - <tr class="a"> - <th>Name</th> - <th>Type</th> - <th>Since</th> - <th>Description</th> - </tr> - <tr class="b"> - <td><b><a href="#file">file</a></b></td> - <td><tt>File</tt></td> - <td><tt>-</tt></td> - <td>File to be deployed.<br /><b>User property is</b>: <tt>file</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#repositoryId">repositoryId</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>Server Id to map on the <id> under <server> section of -settings.xml In most cases, this parameter will be required for -authentication.<br /><b>Default value is</b>: <tt>remote-repository</tt>.<br /><b>User property is</b>: <tt>repositoryId</tt>.</td> - </tr> - </table> - </div> - <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3> - <table class="bodyTable" border="0"> - <tr class="a"> - <th>Name</th> - <th>Type</th> - <th>Since</th> - <th>Description</th> - </tr> - <tr class="b"> - <td><b><a href="#artifactId">artifactId</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>ArtifactId of the artifact to be deployed. Retrieved from POM file -if specified.<br /><b>User property is</b>: <tt>artifactId</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#classifier">classifier</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>Add classifier to the artifact<br /><b>User property is</b>: <tt>classifier</tt>.</td> - </tr> - <tr class="b"> - <td><b><a href="#classifiers">classifiers</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>A comma separated list of classifiers for each of the extra side -artifacts to deploy. If there is a mis-match in the number of -entries in <tt>files</tt> or <tt>types</tt>, then an error -will be raised.<br /><b>User property is</b>: <tt>classifiers</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#description">description</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>Description passed to a generated POM file (in case of -generatePom=true)<br /><b>User property is</b>: <tt>generatePom.description</tt>.</td> - </tr> - <tr class="b"> - <td><b><a href="#files">files</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>A comma separated list of files for each of the extra side -artifacts to deploy. If there is a mis-match in the number of -entries in <tt>types</tt> or <tt>classifiers</tt>, then an -error will be raised.<br /><b>User property is</b>: <tt>files</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#generatePom">generatePom</a></b></td> - <td><tt>boolean</tt></td> - <td><tt>-</tt></td> - <td>Upload a POM for this artifact. Will generate a default POM if none -is supplied with the pomFile argument.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>generatePom</tt>.</td> - </tr> - <tr class="b"> - <td><b><a href="#groupId">groupId</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>GroupId of the artifact to be deployed. Retrieved from POM file if -specified.<br /><b>User property is</b>: <tt>groupId</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#javadoc">javadoc</a></b></td> - <td><tt>File</tt></td> - <td><tt>-</tt></td> - <td>The bundled API docs for the artifact.<br /><b>User property is</b>: <tt>javadoc</tt>.</td> - </tr> - <tr class="b"> - <td><b><a href="#packaging">packaging</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>Type of the artifact to be deployed. Retrieved from the -<packaging> element of the POM file if a POM file specified. -Defaults to the file extension if it is not specified via command -line or POM.<br /> -Maven uses two terms to refer to this datum: the <packaging> -element for the entire POM, and the <type> element in a -dependency specification.<br /><b>User property is</b>: <tt>packaging</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#pomFile">pomFile</a></b></td> - <td><tt>File</tt></td> - <td><tt>-</tt></td> - <td>Location of an existing POM file to be deployed alongside the main -artifact, given by the ${file} parameter.<br /><b>User property is</b>: <tt>pomFile</tt>.</td> - </tr> - <tr class="b"> - <td><b><a href="#repositoryLayout">repositoryLayout</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>The type of remote repository layout to deploy to. Try -<i>legacy</i> for a Maven 1.x-style repository layout.<br /><b>Default value is</b>: <tt>default</tt>.<br /><b>User property is</b>: <tt>repositoryLayout</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#retryFailedDeploymentCount">retryFailedDeploymentCount</a></b></td> - <td><tt>int</tt></td> - <td><tt>2.7</tt></td> - <td>Parameter used to control how many times a failed deployment will -be retried before giving up and failing. If a value outside the -range 1-10 is specified it will be pulled to the nearest value -within the range 1-10.<br /><b>Default value is</b>: <tt>1</tt>.<br /><b>User property is</b>: <tt>retryFailedDeploymentCount</tt>.</td> - </tr> - <tr class="b"> - <td><b><a href="#sources">sources</a></b></td> - <td><tt>File</tt></td> - <td><tt>-</tt></td> - <td>The bundled sources for the artifact.<br /><b>User property is</b>: <tt>sources</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#types">types</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>A comma separated list of types for each of the extra side -artifacts to deploy. If there is a mis-match in the number of -entries in <tt>files</tt> or <tt>classifiers</tt>, then an -error will be raised.<br /><b>User property is</b>: <tt>types</tt>.</td> - </tr> - <tr class="b"> - <td><b><a href="#uniqueVersion">uniqueVersion</a></b></td> - <td><tt>boolean</tt></td> - <td><tt>-</tt></td> - <td>Whether to deploy snapshots with a unique version or not.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>uniqueVersion</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#updateReleaseInfo">updateReleaseInfo</a></b></td> - <td><tt>boolean</tt></td> - <td><tt>-</tt></td> - <td>Parameter used to update the metadata to make the artifact as -release.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>updateReleaseInfo</tt>.</td> - </tr> - <tr class="b"> - <td><b><a href="#url">url</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>URL where the artifact will be deployed. <br /> -ie ( file:///C:/m2-repo or scp://host.com/path/to/repo )<br /><b>User property is</b>: <tt>url</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#version">version</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>Version of the artifact to be deployed. Retrieved from POM file if -specified.<br /><b>User property is</b>: <tt>version</tt>.</td> - </tr> - </table> - </div> - <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3> - <p><b><a name="artifactId">artifactId</a>:</b></p> - <div>ArtifactId of the artifact to be deployed. Retrieved from POM file -if specified.</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>artifactId</tt></li> - </ul><hr /><p><b><a name="classifier">classifier</a>:</b></p> - <div>Add classifier to the artifact</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>classifier</tt></li> - </ul><hr /><p><b><a name="classifiers">classifiers</a>:</b></p> - <div>A comma separated list of classifiers for each of the extra side -artifacts to deploy. If there is a mis-match in the number of -entries in <tt>files</tt> or <tt>types</tt>, then an error -will be raised.</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>classifiers</tt></li> - </ul><hr /><p><b><a name="description">description</a>:</b></p> - <div>Description passed to a generated POM file (in case of -generatePom=true)</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>generatePom.description</tt></li> - </ul><hr /><p><b><a name="file">file</a>:</b></p> - <div>File to be deployed.</div> - <ul> - <li><b>Type</b>: <tt>java.io.File</tt></li> - <li><b>Required</b>: <tt>Yes</tt></li> - <li><b>User Property</b>: <tt>file</tt></li> - </ul><hr /><p><b><a name="files">files</a>:</b></p> - <div>A comma separated list of files for each of the extra side -artifacts to deploy. If there is a mis-match in the number of -entries in <tt>types</tt> or <tt>classifiers</tt>, then an -error will be raised.</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>files</tt></li> - </ul><hr /><p><b><a name="generatePom">generatePom</a>:</b></p> - <div>Upload a POM for this artifact. Will generate a default POM if none -is supplied with the pomFile argument.</div> - <ul> - <li><b>Type</b>: <tt>boolean</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>generatePom</tt></li> - <li><b>Default</b>: <tt>true</tt></li> - </ul><hr /><p><b><a name="groupId">groupId</a>:</b></p> - <div>GroupId of the artifact to be deployed. Retrieved from POM file if -specified.</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>groupId</tt></li> - </ul><hr /><p><b><a name="javadoc">javadoc</a>:</b></p> - <div>The bundled API docs for the artifact.</div> - <ul> - <li><b>Type</b>: <tt>java.io.File</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>javadoc</tt></li> - </ul><hr /><p><b><a name="packaging">packaging</a>:</b></p> - <div>Type of the artifact to be deployed. Retrieved from the -<packaging> element of the POM file if a POM file specified. -Defaults to the file extension if it is not specified via command -line or POM.<br /> -Maven uses two terms to refer to this datum: the <packaging> -element for the entire POM, and the <type> element in a -dependency specification.</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>packaging</tt></li> - </ul><hr /><p><b><a name="pomFile">pomFile</a>:</b></p> - <div>Location of an existing POM file to be deployed alongside the main -artifact, given by the ${file} parameter.</div> - <ul> - <li><b>Type</b>: <tt>java.io.File</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>pomFile</tt></li> - </ul><hr /><p><b><a name="repositoryId">repositoryId</a>:</b></p> - <div>Server Id to map on the <id> under <server> section of -settings.xml In most cases, this parameter will be required for -authentication.</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>Yes</tt></li> - <li><b>User Property</b>: <tt>repositoryId</tt></li> - <li><b>Default</b>: <tt>remote-repository</tt></li> - </ul><hr /><p><b><a name="repositoryLayout">repositoryLayout</a>:</b></p> - <div>The type of remote repository layout to deploy to. Try -<i>legacy</i> for a Maven 1.x-style repository layout.</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>repositoryLayout</tt></li> - <li><b>Default</b>: <tt>default</tt></li> - </ul><hr /><p><b><a name="retryFailedDeploymentCount">retryFailedDeploymentCount</a>:</b></p> - <div>Parameter used to control how many times a failed deployment will -be retried before giving up and failing. If a value outside the -range 1-10 is specified it will be pulled to the nearest value -within the range 1-10.</div> - <ul> - <li><b>Type</b>: <tt>int</tt></li> - <li><b>Since</b>: <tt>2.7</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>retryFailedDeploymentCount</tt></li> - <li><b>Default</b>: <tt>1</tt></li> - </ul><hr /><p><b><a name="sources">sources</a>:</b></p> - <div>The bundled sources for the artifact.</div> - <ul> - <li><b>Type</b>: <tt>java.io.File</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>sources</tt></li> - </ul><hr /><p><b><a name="types">types</a>:</b></p> - <div>A comma separated list of types for each of the extra side -artifacts to deploy. If there is a mis-match in the number of -entries in <tt>files</tt> or <tt>classifiers</tt>, then an -error will be raised.</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>types</tt></li> - </ul><hr /><p><b><a name="uniqueVersion">uniqueVersion</a>:</b></p> - <div>Whether to deploy snapshots with a unique version or not.</div> - <ul> - <li><b>Type</b>: <tt>boolean</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>uniqueVersion</tt></li> - <li><b>Default</b>: <tt>true</tt></li> - </ul><hr /><p><b><a name="updateReleaseInfo">updateReleaseInfo</a>:</b></p> - <div>Parameter used to update the metadata to make the artifact as -release.</div> - <ul> - <li><b>Type</b>: <tt>boolean</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>updateReleaseInfo</tt></li> - <li><b>Default</b>: <tt>false</tt></li> - </ul><hr /><p><b><a name="url">url</a>:</b></p> - <div>URL where the artifact will be deployed. <br /> -ie ( file:///C:/m2-repo or scp://host.com/path/to/repo )</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>url</tt></li> - </ul><hr /><p><b><a name="version">version</a>:</b></p> - <div>Version of the artifact to be deployed. Retrieved from POM file if -specified.</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>version</tt></li> - </ul> - </div> - </div> - - - </div> - </div> - <div class="clear"> - <hr/> - </div> - <div id="footer"> - <div class="xright"> - © 2004-2013 - The Apache Software Foundation - - - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. - Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation. - </div> - <div class="clear"> - <hr/> - </div> - </div> - </body> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<!-- + | Generated by Apache Maven Doxia at 2014-08-27 + | Rendered using Apache Maven Stylus Skin 1.5 +--> +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <title>Apache Maven Deploy Plugin - + deploy:deploy-file</title> + <style type="text/css" media="all"> + @import url("./css/maven-base.css"); + @import url("./css/maven-theme.css"); + @import url("./css/site.css"); + </style> + <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> + <meta name="Date-Revision-yyyymmdd" content="20140827" /> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + +<script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> + +<script type="text/javascript">_uacct = "UA-140879-1"; + urchinTracker();</script> + </head> + <body class="composite"> + <div id="banner"> + <a href="../../" id="bannerLeft"> + <img src="../../images/apache-maven-project-2.png" alt="" /> + </a> + <span id="bannerRight"> + <img src="../../images/maven-logo-2.gif" alt="" /> + </span> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + + <div class="xleft"> + <a href="http://www.apache.org/"; class="externalLink">Apache</a> + > + <a href="../../index.html">Maven</a> + > + <a href="../index.html">Plugins</a> + > + <a href="./">Apache Maven Deploy Plugin</a> + > + + deploy:deploy-file + </div> + <div class="xright"> + Last Published: 2014-08-27 + | Version: 2.8.2 + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + <h5>Overview</h5> + <ul> + <li class="none"> + <a href="index.html">Introduction</a> + </li> + <li class="none"> + <a href="plugin-info.html">Goals</a> + </li> + <li class="none"> + <a href="usage.html">Usage</a> + </li> + <li class="none"> + <a href="faq.html">FAQ</a> + </li> + <li class="none"> + <a href="jira-report.html">Release Notes</a> + </li> + <li class="none"> + <a href="http://www.apache.org/licenses/"; class="externalLink">License</a> + </li> + <li class="none"> + <a href="download.html">Download</a> + </li> + </ul> + <h5>Examples</h5> + <ul> + <li class="collapsed"> + <a href="project-deployment.html">Project Deployment</a> + </li> + <li class="collapsed"> + <a href="file-deployment.html">File Deployment</a> + </li> + </ul> + <h5>Project Documentation</h5> + <ul> + <li class="collapsed"> + <a href="project-info.html">Project Information</a> + </li> + <li class="collapsed"> + <a href="project-reports.html">Project Reports</a> + </li> + </ul> + <h5>Maven Projects</h5> + <ul> + <li class="none"> + <a href="../../ant-tasks/index.html">Ant Tasks</a> + </li> + <li class="none"> + <a href="../../archetype/index.html">Archetype</a> + </li> + <li class="none"> + <a href="../../doxia/index.html">Doxia</a> + </li> + <li class="none"> + <a href="../../jxr/index.html">JXR</a> + </li> + <li class="none"> + <a href="../../maven-1.x/index.html">Maven 1.x</a> + </li> + <li class="none"> + <a href="../../index.html">Maven 2 & 3</a> + </li> + <li class="none"> + <a href="../../pom/index.html">Parent POMs</a> + </li> + <li class="none"> + <a href="../index.html">Plugins</a> + </li> + <li class="none"> + <a href="../../plugin-tools/index.html">Plugin Tools</a> + </li> + <li class="none"> + <a href="../../scm/index.html">SCM</a> + </li> + <li class="none"> + <a href="../../shared/index.html">Shared Components</a> + </li> + <li class="none"> + <a href="../../skins/index.html">Skins</a> + </li> + <li class="none"> + <a href="../../surefire/index.html">Surefire</a> + </li> + <li class="none"> + <a href="../../wagon/index.html">Wagon</a> + </li> + </ul> + <h5>ASF</h5> + <ul> + <li class="none"> + <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink">How Apache Works</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/"; class="externalLink">Foundation</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink">Sponsoring Apache</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink">Thanks</a> + </li> + </ul> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img alt="Built by Maven" src="./images/logos/maven-feather.png"/> + </a> + + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + + + <div class="section"> +<h2>deploy:deploy-file<a name="deploy:deploy-file"></a></h2> + +<p><b>Full name</b>:</p> + +<p>org.apache.maven.plugins:maven-deploy-plugin:2.8.2:deploy-file</p> + +<p><b>Description</b>:</p> + +<div>Installs the artifact in the remote repository.</div> + +<p><b>Attributes</b>:</p> + +<ul> + +<li>The goal is thread-safe and supports parallel builds.</li> + </ul> + +<div class="section"> +<h3>Required Parameters<a name="Required_Parameters"></a></h3> + +<table class="bodyTable" border="0"> + +<tr class="a"> + +<th>Name</th> + +<th>Type</th> + +<th>Since</th> + +<th>Description</th> + </tr> + +<tr class="b"> + +<td><b><a href="#file">file</a></b></td> + +<td><tt>File</tt></td> + +<td><tt>-</tt></td> + +<td>File to be deployed.<br /><b>User property is</b>: <tt>file</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#repositoryId">repositoryId</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>Server Id to map on the <id> under <server> section of +settings.xml In most cases, this parameter will be required for +authentication.<br /><b>Default value is</b>: <tt>remote-repository</tt>.<br /><b>User property is</b>: <tt>repositoryId</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#url">url</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>URL where the artifact will be deployed. <br /> +ie ( file:///C:/m2-repo or scp://host.com/path/to/repo )<br /><b>User property is</b>: <tt>url</tt>.</td> + </tr> + </table> + </div> + +<div class="section"> +<h3>Optional Parameters<a name="Optional_Parameters"></a></h3> + +<table class="bodyTable" border="0"> + +<tr class="a"> + +<th>Name</th> + +<th>Type</th> + +<th>Since</th> + +<th>Description</th> + </tr> + +<tr class="b"> + +<td><b><a href="#artifactId">artifactId</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>ArtifactId of the artifact to be deployed. Retrieved from POM file +if specified.<br /><b>User property is</b>: <tt>artifactId</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#classifier">classifier</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>Add classifier to the artifact<br /><b>User property is</b>: <tt>classifier</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#classifiers">classifiers</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>A comma separated list of classifiers for each of the extra side +artifacts to deploy. If there is a mis-match in the number of +entries in <tt>files</tt> or <tt>types</tt>, then an error +will be raised.<br /><b>User property is</b>: <tt>classifiers</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#description">description</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>Description passed to a generated POM file (in case of +generatePom=true)<br /><b>User property is</b>: <tt>generatePom.description</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#files">files</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>A comma separated list of files for each of the extra side +artifacts to deploy. If there is a mis-match in the number of +entries in <tt>types</tt> or <tt>classifiers</tt>, then an +error will be raised.<br /><b>User property is</b>: <tt>files</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#generatePom">generatePom</a></b></td> + +<td><tt>boolean</tt></td> + +<td><tt>-</tt></td> + +<td>Upload a POM for this artifact. Will generate a default POM if none +is supplied with the pomFile argument.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>generatePom</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#groupId">groupId</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>GroupId of the artifact to be deployed. Retrieved from POM file if +specified.<br /><b>User property is</b>: <tt>groupId</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#javadoc">javadoc</a></b></td> + +<td><tt>File</tt></td> + +<td><tt>2.6</tt></td> + +<td>The bundled API docs for the artifact.<br /><b>User property is</b>: <tt>javadoc</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#packaging">packaging</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>Type of the artifact to be deployed. Retrieved from the +<packaging> element of the POM file if a POM file specified. +Defaults to the file extension if it is not specified via command +line or POM.<br /> +Maven uses two terms to refer to this datum: the <packaging> +element for the entire POM, and the <type> element in a +dependency specification.<br /><b>User property is</b>: <tt>packaging</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#pomFile">pomFile</a></b></td> + +<td><tt>File</tt></td> + +<td><tt>-</tt></td> + +<td>Location of an existing POM file to be deployed alongside the main +artifact, given by the ${file} parameter.<br /><b>User property is</b>: <tt>pomFile</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#repositoryLayout">repositoryLayout</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>The type of remote repository layout to deploy to. Try +<i>legacy</i> for a Maven 1.x-style repository layout.<br /><b>Default value is</b>: <tt>default</tt>.<br /><b>User property is</b>: <tt>repositoryLayout</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#retryFailedDeploymentCount">retryFailedDeploymentCount</a></b></td> + +<td><tt>int</tt></td> + +<td><tt>2.7</tt></td> + +<td>Parameter used to control how many times a failed deployment will +be retried before giving up and failing. If a value outside the +range 1-10 is specified it will be pulled to the nearest value +within the range 1-10.<br /><b>Default value is</b>: <tt>1</tt>.<br /><b>User property is</b>: <tt>retryFailedDeploymentCount</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#sources">sources</a></b></td> + +<td><tt>File</tt></td> + +<td><tt>2.6</tt></td> + +<td>The bundled sources for the artifact.<br /><b>User property is</b>: <tt>sources</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#types">types</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>A comma separated list of types for each of the extra side +artifacts to deploy. If there is a mis-match in the number of +entries in <tt>files</tt> or <tt>classifiers</tt>, then an +error will be raised.<br /><b>User property is</b>: <tt>types</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#uniqueVersion">uniqueVersion</a></b></td> + +<td><tt>boolean</tt></td> + +<td><tt>-</tt></td> + +<td>Whether to deploy snapshots with a unique version or not.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>uniqueVersion</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#updateReleaseInfo">updateReleaseInfo</a></b></td> + +<td><tt>boolean</tt></td> + +<td><tt>-</tt></td> + +<td>Parameter used to update the metadata to make the artifact as +release.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>updateReleaseInfo</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#version">version</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>Version of the artifact to be deployed. Retrieved from POM file if +specified.<br /><b>User property is</b>: <tt>version</tt>.</td> + </tr> + </table> + </div> + +<div class="section"> +<h3>Parameter Details<a name="Parameter_Details"></a></h3> + +<p><b><a name="artifactId">artifactId</a>:</b></p> + +<div>ArtifactId of the artifact to be deployed. Retrieved from POM file +if specified.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>artifactId</tt></li> + </ul><hr /> +<p><b><a name="classifier">classifier</a>:</b></p> + +<div>Add classifier to the artifact</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>classifier</tt></li> + </ul><hr /> +<p><b><a name="classifiers">classifiers</a>:</b></p> + +<div>A comma separated list of classifiers for each of the extra side +artifacts to deploy. If there is a mis-match in the number of +entries in <tt>files</tt> or <tt>types</tt>, then an error +will be raised.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>classifiers</tt></li> + </ul><hr /> +<p><b><a name="description">description</a>:</b></p> + +<div>Description passed to a generated POM file (in case of +generatePom=true)</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>generatePom.description</tt></li> + </ul><hr /> +<p><b><a name="file">file</a>:</b></p> + +<div>File to be deployed.</div> + +<ul> + +<li><b>Type</b>: <tt>java.io.File</tt></li> + +<li><b>Required</b>: <tt>Yes</tt></li> + +<li><b>User Property</b>: <tt>file</tt></li> + </ul><hr /> +<p><b><a name="files">files</a>:</b></p> + +<div>A comma separated list of files for each of the extra side +artifacts to deploy. If there is a mis-match in the number of +entries in <tt>types</tt> or <tt>classifiers</tt>, then an +error will be raised.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>files</tt></li> + </ul><hr /> +<p><b><a name="generatePom">generatePom</a>:</b></p> + +<div>Upload a POM for this artifact. Will generate a default POM if none +is supplied with the pomFile argument.</div> + +<ul> + +<li><b>Type</b>: <tt>boolean</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>generatePom</tt></li> + +<li><b>Default</b>: <tt>true</tt></li> + </ul><hr /> +<p><b><a name="groupId">groupId</a>:</b></p> + +<div>GroupId of the artifact to be deployed. Retrieved from POM file if +specified.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>groupId</tt></li> + </ul><hr /> +<p><b><a name="javadoc">javadoc</a>:</b></p> + +<div>The bundled API docs for the artifact.</div> + +<ul> + +<li><b>Type</b>: <tt>java.io.File</tt></li> + +<li><b>Since</b>: <tt>2.6</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>javadoc</tt></li> + </ul><hr /> +<p><b><a name="packaging">packaging</a>:</b></p> + +<div>Type of the artifact to be deployed. Retrieved from the +<packaging> element of the POM file if a POM file specified. +Defaults to the file extension if it is not specified via command +line or POM.<br /> +Maven uses two terms to refer to this datum: the <packaging> +element for the entire POM, and the <type> element in a +dependency specification.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>packaging</tt></li> + </ul><hr /> +<p><b><a name="pomFile">pomFile</a>:</b></p> + +<div>Location of an existing POM file to be deployed alongside the main +artifact, given by the ${file} parameter.</div> + +<ul> + +<li><b>Type</b>: <tt>java.io.File</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>pomFile</tt></li> + </ul><hr /> +<p><b><a name="repositoryId">repositoryId</a>:</b></p> + +<div>Server Id to map on the <id> under <server> section of +settings.xml In most cases, this parameter will be required for +authentication.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>Yes</tt></li> + +<li><b>User Property</b>: <tt>repositoryId</tt></li> + +<li><b>Default</b>: <tt>remote-repository</tt></li> + </ul><hr /> +<p><b><a name="repositoryLayout">repositoryLayout</a>:</b></p> + +<div>The type of remote repository layout to deploy to. Try +<i>legacy</i> for a Maven 1.x-style repository layout.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>repositoryLayout</tt></li> + +<li><b>Default</b>: <tt>default</tt></li> + </ul><hr /> +<p><b><a name="retryFailedDeploymentCount">retryFailedDeploymentCount</a>:</b></p> + +<div>Parameter used to control how many times a failed deployment will +be retried before giving up and failing. If a value outside the +range 1-10 is specified it will be pulled to the nearest value +within the range 1-10.</div> + +<ul> + +<li><b>Type</b>: <tt>int</tt></li> + +<li><b>Since</b>: <tt>2.7</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>retryFailedDeploymentCount</tt></li> + +<li><b>Default</b>: <tt>1</tt></li> + </ul><hr /> +<p><b><a name="sources">sources</a>:</b></p> + +<div>The bundled sources for the artifact.</div> + +<ul> + +<li><b>Type</b>: <tt>java.io.File</tt></li> + +<li><b>Since</b>: <tt>2.6</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>sources</tt></li> + </ul><hr /> +<p><b><a name="types">types</a>:</b></p> + +<div>A comma separated list of types for each of the extra side +artifacts to deploy. If there is a mis-match in the number of +entries in <tt>files</tt> or <tt>classifiers</tt>, then an +error will be raised.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>types</tt></li> + </ul><hr /> +<p><b><a name="uniqueVersion">uniqueVersion</a>:</b></p> + +<div>Whether to deploy snapshots with a unique version or not.</div> + +<ul> + +<li><b>Type</b>: <tt>boolean</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>uniqueVersion</tt></li> + +<li><b>Default</b>: <tt>true</tt></li> + </ul><hr /> +<p><b><a name="updateReleaseInfo">updateReleaseInfo</a>:</b></p> + +<div>Parameter used to update the metadata to make the artifact as +release.</div> + +<ul> + +<li><b>Type</b>: <tt>boolean</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>updateReleaseInfo</tt></li> + +<li><b>Default</b>: <tt>false</tt></li> + </ul><hr /> +<p><b><a name="url">url</a>:</b></p> + +<div>URL where the artifact will be deployed. <br /> +ie ( file:///C:/m2-repo or scp://host.com/path/to/repo )</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>Yes</tt></li> + +<li><b>User Property</b>: <tt>url</tt></li> + </ul><hr /> +<p><b><a name="version">version</a>:</b></p> + +<div>Version of the artifact to be deployed. Retrieved from POM file if +specified.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>version</tt></li> + </ul> + </div> + </div> + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright"> + © 2004-2014 + The Apache Software Foundation + + - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. + Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation. + </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> </html> \ No newline at end of file
Modified: websites/production/maven/content/plugins-archives/maven-deploy-plugin-LATEST/deploy-mojo.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-deploy-plugin-LATEST/deploy-mojo.html (original) +++ websites/production/maven/content/plugins-archives/maven-deploy-plugin-LATEST/deploy-mojo.html Wed Aug 27 20:27:59 2014 @@ -1,351 +1,477 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<!-- - | Generated by Apache Maven Doxia at Oct 19, 2013 - | Rendered using Apache Maven Stylus Skin 1.5 ---> -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <title>Apache Maven Deploy Plugin - - deploy:deploy</title> - <style type="text/css" media="all"> - @import url("./css/maven-base.css"); - @import url("./css/maven-theme.css"); - @import url("./css/site.css"); - </style> - <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20131019" /> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - -<script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> - -<script type="text/javascript">_uacct = "UA-140879-1"; - urchinTracker();</script> - </head> - <body class="composite"> - <div id="banner"> - <a href="../../" id="bannerLeft"> - <img src="../../images/apache-maven-project-2.png" alt="" /> - </a> - <span id="bannerRight"> - <img src="../../images/maven-logo-2.gif" alt="" /> - </span> - <div class="clear"> - <hr/> - </div> - </div> - <div id="breadcrumbs"> - - <div class="xleft"> - <a href="http://www.apache.org/"; class="externalLink">Apache</a> - > - <a href="../../index.html">Maven</a> - > - <a href="../index.html">Plugins</a> - > - <a href="./">Apache Maven Deploy Plugin</a> - > - - deploy:deploy - </div> - <div class="xright"> - Last Published: 2013-10-19 - | Version: 2.8.1 - </div> - <div class="clear"> - <hr/> - </div> - </div> - <div id="leftColumn"> - <div id="navcolumn"> - - <h5>Overview</h5> - <ul> - <li class="none"> - <a href="index.html">Introduction</a> - </li> - <li class="none"> - <a href="plugin-info.html">Goals</a> - </li> - <li class="none"> - <a href="usage.html">Usage</a> - </li> - <li class="none"> - <a href="faq.html">FAQ</a> - </li> - <li class="none"> - <a href="jira-report.html">Release Notes</a> - </li> - </ul> - <h5>Examples</h5> - <ul> - <li class="collapsed"> - <a href="project-deployment.html">Project Deployment</a> - </li> - <li class="collapsed"> - <a href="file-deployment.html">File Deployment</a> - </li> - </ul> - <h5>Project Documentation</h5> - <ul> - <li class="collapsed"> - <a href="project-info.html">Project Information</a> - </li> - <li class="collapsed"> - <a href="project-reports.html">Project Reports</a> - </li> - </ul> - <h5>Maven Projects</h5> - <ul> - <li class="none"> - <a href="../../ant-tasks/index.html">Ant Tasks</a> - </li> - <li class="none"> - <a href="../../archetype/index.html">Archetype</a> - </li> - <li class="none"> - <a href="../../doxia/index.html">Doxia</a> - </li> - <li class="none"> - <a href="../../jxr/index.html">JXR</a> - </li> - <li class="none"> - <a href="../../maven-1.x/index.html">Maven 1.x</a> - </li> - <li class="none"> - <a href="../../index.html">Maven 2 & 3</a> - </li> - <li class="none"> - <a href="../../pom/index.html">Parent POMs</a> - </li> - <li class="none"> - <a href="../index.html">Plugins</a> - </li> - <li class="none"> - <a href="../../plugin-tools/index.html">Plugin Tools</a> - </li> - <li class="none"> - <a href="../../scm/index.html">SCM</a> - </li> - <li class="none"> - <a href="../../shared/index.html">Shared Components</a> - </li> - <li class="none"> - <a href="../../skins/index.html">Skins</a> - </li> - <li class="none"> - <a href="../../surefire/index.html">Surefire</a> - </li> - <li class="none"> - <a href="../../wagon/index.html">Wagon</a> - </li> - </ul> - <h5>ASF</h5> - <ul> - <li class="none"> - <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink">How Apache Works</a> - </li> - <li class="none"> - <a href="http://www.apache.org/foundation/"; class="externalLink">Foundation</a> - </li> - <li class="none"> - <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink">Sponsoring Apache</a> - </li> - <li class="none"> - <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink">Thanks</a> - </li> - </ul> - <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> - <img alt="Built by Maven" src="./images/logos/maven-feather.png"/> - </a> - - </div> - </div> - <div id="bodyColumn"> - <div id="contentBox"> - - - <div class="section"><h2>deploy:deploy<a name="deploy:deploy"></a></h2> - <p><b>Full name</b>:</p> - <p>org.apache.maven.plugins:maven-deploy-plugin:2.8.1:deploy</p> - <p><b>Description</b>:</p> - <div>Deploys an artifact to remote repository.</div> - <p><b>Attributes</b>:</p> - <ul> - <li>Requires a Maven project to be executed.</li> - <li>The goal is thread-safe and supports parallel builds.</li> - <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html";>lifecycle phase</a>: <tt>deploy</tt>.</li> - </ul> - <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3> - <table class="bodyTable" border="0"> - <tr class="a"> - <th>Name</th> - <th>Type</th> - <th>Since</th> - <th>Description</th> - </tr> - <tr class="b"> - <td><b><a href="#altDeploymentRepository">altDeploymentRepository</a></b></td> - <td><tt>String</tt></td> - <td><tt>-</tt></td> - <td>Specifies an alternative repository to which the project artifacts -should be deployed ( other than those specified in -<distributionManagement> ). <br /> -Format: id::layout::url -<dl> -<dt>id</dt> -<dd>The id can be used to pick up the correct credentials from the -settings.xml</dd> -<dt>layout</dt> -<dd>Either <tt>default</tt> for the Maven2 layout or -<tt>legacy</tt> for the Maven1 layout. Maven3 also uses the -<tt>default</tt> layout.</dd> -<dt>url</dt> -<dd>The location of the repository</dd> -</dl><br /><b>User property is</b>: <tt>altDeploymentRepository</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#altReleaseDeploymentRepository">altReleaseDeploymentRepository</a></b></td> - <td><tt>String</tt></td> - <td><tt>2.8</tt></td> - <td>The alternative repository to use when the project has a final -version.<br /><b>User property is</b>: <tt>altReleaseDeploymentRepository</tt>.</td> - </tr> - <tr class="b"> - <td><b><a href="#altSnapshotDeploymentRepository">altSnapshotDeploymentRepository</a></b></td> - <td><tt>String</tt></td> - <td><tt>2.8</tt></td> - <td>The alternative repository to use when the project has a snapshot -version.<br /><b>User property is</b>: <tt>altSnapshotDeploymentRepository</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#deployAtEnd">deployAtEnd</a></b></td> - <td><tt>boolean</tt></td> - <td><tt>2.8</tt></td> - <td>Whether every project should be deployed during its own -deploy-phase or at the end of the multimodule build. If set to -<tt>true</tt> and the build fails, none of the reactor projects -is deployed<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>deployAtEnd</tt>.</td> - </tr> - <tr class="b"> - <td><b><a href="#retryFailedDeploymentCount">retryFailedDeploymentCount</a></b></td> - <td><tt>int</tt></td> - <td><tt>2.7</tt></td> - <td>Parameter used to control how many times a failed deployment will -be retried before giving up and failing. If a value outside the -range 1-10 is specified it will be pulled to the nearest value -within the range 1-10.<br /><b>Default value is</b>: <tt>1</tt>.<br /><b>User property is</b>: <tt>retryFailedDeploymentCount</tt>.</td> - </tr> - <tr class="a"> - <td><b><a href="#skip">skip</a></b></td> - <td><tt>boolean</tt></td> - <td><tt>2.4</tt></td> - <td>Set this to 'true' to bypass artifact deploy<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>maven.deploy.skip</tt>.</td> - </tr> - <tr class="b"> - <td><b><a href="#updateReleaseInfo">updateReleaseInfo</a></b></td> - <td><tt>boolean</tt></td> - <td><tt>-</tt></td> - <td>Parameter used to update the metadata to make the artifact as -release.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>updateReleaseInfo</tt>.</td> - </tr> - </table> - </div> - <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3> - <p><b><a name="altDeploymentRepository">altDeploymentRepository</a>:</b></p> - <div>Specifies an alternative repository to which the project artifacts -should be deployed ( other than those specified in -<distributionManagement> ). <br /> -Format: id::layout::url -<dl> -<dt>id</dt> -<dd>The id can be used to pick up the correct credentials from the -settings.xml</dd> -<dt>layout</dt> -<dd>Either <tt>default</tt> for the Maven2 layout or -<tt>legacy</tt> for the Maven1 layout. Maven3 also uses the -<tt>default</tt> layout.</dd> -<dt>url</dt> -<dd>The location of the repository</dd> -</dl></div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>altDeploymentRepository</tt></li> - </ul><hr /><p><b><a name="altReleaseDeploymentRepository">altReleaseDeploymentRepository</a>:</b></p> - <div>The alternative repository to use when the project has a final -version.</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Since</b>: <tt>2.8</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>altReleaseDeploymentRepository</tt></li> - </ul><hr /><p><b><a name="altSnapshotDeploymentRepository">altSnapshotDeploymentRepository</a>:</b></p> - <div>The alternative repository to use when the project has a snapshot -version.</div> - <ul> - <li><b>Type</b>: <tt>java.lang.String</tt></li> - <li><b>Since</b>: <tt>2.8</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>altSnapshotDeploymentRepository</tt></li> - </ul><hr /><p><b><a name="deployAtEnd">deployAtEnd</a>:</b></p> - <div>Whether every project should be deployed during its own -deploy-phase or at the end of the multimodule build. If set to -<tt>true</tt> and the build fails, none of the reactor projects -is deployed</div> - <ul> - <li><b>Type</b>: <tt>boolean</tt></li> - <li><b>Since</b>: <tt>2.8</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>deployAtEnd</tt></li> - <li><b>Default</b>: <tt>false</tt></li> - </ul><hr /><p><b><a name="retryFailedDeploymentCount">retryFailedDeploymentCount</a>:</b></p> - <div>Parameter used to control how many times a failed deployment will -be retried before giving up and failing. If a value outside the -range 1-10 is specified it will be pulled to the nearest value -within the range 1-10.</div> - <ul> - <li><b>Type</b>: <tt>int</tt></li> - <li><b>Since</b>: <tt>2.7</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>retryFailedDeploymentCount</tt></li> - <li><b>Default</b>: <tt>1</tt></li> - </ul><hr /><p><b><a name="skip">skip</a>:</b></p> - <div>Set this to 'true' to bypass artifact deploy</div> - <ul> - <li><b>Type</b>: <tt>boolean</tt></li> - <li><b>Since</b>: <tt>2.4</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>maven.deploy.skip</tt></li> - <li><b>Default</b>: <tt>false</tt></li> - </ul><hr /><p><b><a name="updateReleaseInfo">updateReleaseInfo</a>:</b></p> - <div>Parameter used to update the metadata to make the artifact as -release.</div> - <ul> - <li><b>Type</b>: <tt>boolean</tt></li> - <li><b>Required</b>: <tt>No</tt></li> - <li><b>User Property</b>: <tt>updateReleaseInfo</tt></li> - <li><b>Default</b>: <tt>false</tt></li> - </ul> - </div> - </div> - - - </div> - </div> - <div class="clear"> - <hr/> - </div> - <div id="footer"> - <div class="xright"> - © 2004-2013 - The Apache Software Foundation - - - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. - Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation. - </div> - <div class="clear"> - <hr/> - </div> - </div> - </body> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<!-- + | Generated by Apache Maven Doxia at 2014-08-27 + | Rendered using Apache Maven Stylus Skin 1.5 +--> +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <title>Apache Maven Deploy Plugin - + deploy:deploy</title> + <style type="text/css" media="all"> + @import url("./css/maven-base.css"); + @import url("./css/maven-theme.css"); + @import url("./css/site.css"); + </style> + <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> + <meta name="Date-Revision-yyyymmdd" content="20140827" /> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + +<script src="http://www.google-analytics.com/urchin.js"; type="text/javascript"></script> + +<script type="text/javascript">_uacct = "UA-140879-1"; + urchinTracker();</script> + </head> + <body class="composite"> + <div id="banner"> + <a href="../../" id="bannerLeft"> + <img src="../../images/apache-maven-project-2.png" alt="" /> + </a> + <span id="bannerRight"> + <img src="../../images/maven-logo-2.gif" alt="" /> + </span> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + + <div class="xleft"> + <a href="http://www.apache.org/"; class="externalLink">Apache</a> + > + <a href="../../index.html">Maven</a> + > + <a href="../index.html">Plugins</a> + > + <a href="./">Apache Maven Deploy Plugin</a> + > + + deploy:deploy + </div> + <div class="xright"> + Last Published: 2014-08-27 + | Version: 2.8.2 + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + <h5>Overview</h5> + <ul> + <li class="none"> + <a href="index.html">Introduction</a> + </li> + <li class="none"> + <a href="plugin-info.html">Goals</a> + </li> + <li class="none"> + <a href="usage.html">Usage</a> + </li> + <li class="none"> + <a href="faq.html">FAQ</a> + </li> + <li class="none"> + <a href="jira-report.html">Release Notes</a> + </li> + <li class="none"> + <a href="http://www.apache.org/licenses/"; class="externalLink">License</a> + </li> + <li class="none"> + <a href="download.html">Download</a> + </li> + </ul> + <h5>Examples</h5> + <ul> + <li class="collapsed"> + <a href="project-deployment.html">Project Deployment</a> + </li> + <li class="collapsed"> + <a href="file-deployment.html">File Deployment</a> + </li> + </ul> + <h5>Project Documentation</h5> + <ul> + <li class="collapsed"> + <a href="project-info.html">Project Information</a> + </li> + <li class="collapsed"> + <a href="project-reports.html">Project Reports</a> + </li> + </ul> + <h5>Maven Projects</h5> + <ul> + <li class="none"> + <a href="../../ant-tasks/index.html">Ant Tasks</a> + </li> + <li class="none"> + <a href="../../archetype/index.html">Archetype</a> + </li> + <li class="none"> + <a href="../../doxia/index.html">Doxia</a> + </li> + <li class="none"> + <a href="../../jxr/index.html">JXR</a> + </li> + <li class="none"> + <a href="../../maven-1.x/index.html">Maven 1.x</a> + </li> + <li class="none"> + <a href="../../index.html">Maven 2 & 3</a> + </li> + <li class="none"> + <a href="../../pom/index.html">Parent POMs</a> + </li> + <li class="none"> + <a href="../index.html">Plugins</a> + </li> + <li class="none"> + <a href="../../plugin-tools/index.html">Plugin Tools</a> + </li> + <li class="none"> + <a href="../../scm/index.html">SCM</a> + </li> + <li class="none"> + <a href="../../shared/index.html">Shared Components</a> + </li> + <li class="none"> + <a href="../../skins/index.html">Skins</a> + </li> + <li class="none"> + <a href="../../surefire/index.html">Surefire</a> + </li> + <li class="none"> + <a href="../../wagon/index.html">Wagon</a> + </li> + </ul> + <h5>ASF</h5> + <ul> + <li class="none"> + <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink">How Apache Works</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/"; class="externalLink">Foundation</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink">Sponsoring Apache</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink">Thanks</a> + </li> + </ul> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img alt="Built by Maven" src="./images/logos/maven-feather.png"/> + </a> + + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + + + <div class="section"> +<h2>deploy:deploy<a name="deploy:deploy"></a></h2> + +<p><b>Full name</b>:</p> + +<p>org.apache.maven.plugins:maven-deploy-plugin:2.8.2:deploy</p> + +<p><b>Description</b>:</p> + +<div>Deploys an artifact to remote repository.</div> + +<p><b>Attributes</b>:</p> + +<ul> + +<li>Requires a Maven project to be executed.</li> + +<li>The goal is thread-safe and supports parallel builds.</li> + +<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html";>lifecycle phase</a>: <tt>deploy</tt>.</li> + </ul> + +<div class="section"> +<h3>Optional Parameters<a name="Optional_Parameters"></a></h3> + +<table class="bodyTable" border="0"> + +<tr class="a"> + +<th>Name</th> + +<th>Type</th> + +<th>Since</th> + +<th>Description</th> + </tr> + +<tr class="b"> + +<td><b><a href="#altDeploymentRepository">altDeploymentRepository</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>Specifies an alternative repository to which the project artifacts +should be deployed ( other than those specified in +<distributionManagement> ). <br /> +Format: id::layout::url + +<dl> + +<dt>id</dt> + +<dd>The id can be used to pick up the correct credentials from the +settings.xml</dd> + +<dt>layout</dt> + +<dd>Either <tt>default</tt> for the Maven2 layout or +<tt>legacy</tt> for the Maven1 layout. Maven3 also uses the +<tt>default</tt> layout.</dd> + +<dt>url</dt> + +<dd>The location of the repository</dd> +</dl><br /><b>User property is</b>: <tt>altDeploymentRepository</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#altReleaseDeploymentRepository">altReleaseDeploymentRepository</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>2.8</tt></td> + +<td>The alternative repository to use when the project has a final +version.<br /><b>User property is</b>: <tt>altReleaseDeploymentRepository</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#altSnapshotDeploymentRepository">altSnapshotDeploymentRepository</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>2.8</tt></td> + +<td>The alternative repository to use when the project has a snapshot +version.<br /><b>User property is</b>: <tt>altSnapshotDeploymentRepository</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#deployAtEnd">deployAtEnd</a></b></td> + +<td><tt>boolean</tt></td> + +<td><tt>2.8</tt></td> + +<td>Whether every project should be deployed during its own +deploy-phase or at the end of the multimodule build. If set to +<tt>true</tt> and the build fails, none of the reactor projects +is deployed. <b>(experimental)</b><br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>deployAtEnd</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#retryFailedDeploymentCount">retryFailedDeploymentCount</a></b></td> + +<td><tt>int</tt></td> + +<td><tt>2.7</tt></td> + +<td>Parameter used to control how many times a failed deployment will +be retried before giving up and failing. If a value outside the +range 1-10 is specified it will be pulled to the nearest value +within the range 1-10.<br /><b>Default value is</b>: <tt>1</tt>.<br /><b>User property is</b>: <tt>retryFailedDeploymentCount</tt>.</td> + </tr> + +<tr class="a"> + +<td><b><a href="#skip">skip</a></b></td> + +<td><tt>boolean</tt></td> + +<td><tt>2.4</tt></td> + +<td>Set this to 'true' to bypass artifact deploy<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>maven.deploy.skip</tt>.</td> + </tr> + +<tr class="b"> + +<td><b><a href="#updateReleaseInfo">updateReleaseInfo</a></b></td> + +<td><tt>boolean</tt></td> + +<td><tt>-</tt></td> + +<td>Parameter used to update the metadata to make the artifact as +release.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>updateReleaseInfo</tt>.</td> + </tr> + </table> + </div> + +<div class="section"> +<h3>Parameter Details<a name="Parameter_Details"></a></h3> + +<p><b><a name="altDeploymentRepository">altDeploymentRepository</a>:</b></p> + +<div>Specifies an alternative repository to which the project artifacts +should be deployed ( other than those specified in +<distributionManagement> ). <br /> +Format: id::layout::url + +<dl> + +<dt>id</dt> + +<dd>The id can be used to pick up the correct credentials from the +settings.xml</dd> + +<dt>layout</dt> + +<dd>Either <tt>default</tt> for the Maven2 layout or +<tt>legacy</tt> for the Maven1 layout. Maven3 also uses the +<tt>default</tt> layout.</dd> + +<dt>url</dt> + +<dd>The location of the repository</dd> +</dl></div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>altDeploymentRepository</tt></li> + </ul><hr /> +<p><b><a name="altReleaseDeploymentRepository">altReleaseDeploymentRepository</a>:</b></p> + +<div>The alternative repository to use when the project has a final +version.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Since</b>: <tt>2.8</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>altReleaseDeploymentRepository</tt></li> + </ul><hr /> +<p><b><a name="altSnapshotDeploymentRepository">altSnapshotDeploymentRepository</a>:</b></p> + +<div>The alternative repository to use when the project has a snapshot +version.</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Since</b>: <tt>2.8</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>altSnapshotDeploymentRepository</tt></li> + </ul><hr /> +<p><b><a name="deployAtEnd">deployAtEnd</a>:</b></p> + +<div>Whether every project should be deployed during its own +deploy-phase or at the end of the multimodule build. If set to +<tt>true</tt> and the build fails, none of the reactor projects +is deployed. <b>(experimental)</b></div> + +<ul> + +<li><b>Type</b>: <tt>boolean</tt></li> + +<li><b>Since</b>: <tt>2.8</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>deployAtEnd</tt></li> + +<li><b>Default</b>: <tt>false</tt></li> + </ul><hr /> +<p><b><a name="retryFailedDeploymentCount">retryFailedDeploymentCount</a>:</b></p> + +<div>Parameter used to control how many times a failed deployment will +be retried before giving up and failing. If a value outside the +range 1-10 is specified it will be pulled to the nearest value +within the range 1-10.</div> + +<ul> + +<li><b>Type</b>: <tt>int</tt></li> + +<li><b>Since</b>: <tt>2.7</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>retryFailedDeploymentCount</tt></li> + +<li><b>Default</b>: <tt>1</tt></li> + </ul><hr /> +<p><b><a name="skip">skip</a>:</b></p> + +<div>Set this to 'true' to bypass artifact deploy</div> + +<ul> + +<li><b>Type</b>: <tt>boolean</tt></li> + +<li><b>Since</b>: <tt>2.4</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>maven.deploy.skip</tt></li> + +<li><b>Default</b>: <tt>false</tt></li> + </ul><hr /> +<p><b><a name="updateReleaseInfo">updateReleaseInfo</a>:</b></p> + +<div>Parameter used to update the metadata to make the artifact as +release.</div> + +<ul> + +<li><b>Type</b>: <tt>boolean</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + +<li><b>User Property</b>: <tt>updateReleaseInfo</tt></li> + +<li><b>Default</b>: <tt>false</tt></li> + </ul> + </div> + </div> + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright"> + © 2004-2014 + The Apache Software Foundation + + - <a href="http://maven.apache.org/privacy-policy.html";>Privacy Policy</a>. + Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation. + </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> </html> \ No newline at end of file
