You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by hb...@apache.org on 2020/04/12 12:51:17 UTC
svn commit: r1876422 [21/30] - in
/maven/website/components/plugins-archives/maven-gpg-plugin-LATEST: ./
apidocs/ apidocs/org/apache/maven/plugin/ apidocs/org/apache/maven/plugins/
apidocs/org/apache/maven/plugins/gpg/ apidocs/org/apache/maven/plugins/...
Modified: maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/sign-and-deploy-file-mojo.html
==============================================================================
--- maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/sign-and-deploy-file-mojo.html (original)
+++ maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/sign-and-deploy-file-mojo.html Sun Apr 12 12:51:16 2020
@@ -1,1185 +1,1131 @@
-<!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 2015-01-15
- | Rendered using Apache Maven Stylus Skin 1.5
--->
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <title>Apache Maven GPG Plugin – gpg:sign-and-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="20150115" />
- <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 GPG Plugin</a>
- >
- gpg:sign-and-deploy-file
- </div>
- <div class="xright">
- Last Published: 2015-01-15
- | Version: 1.6
- </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="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="none">
- <a href="examples/deploy-signed-artifacts.html">Deploy Signed Artifacts</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="../../ref/current">Maven</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-testing/index.html">Plugin Testing</a>
- </li>
- <li class="none">
- <a href="../../plugin-tools/index.html">Plugin Tools</a>
- </li>
- <li class="none">
- <a href="../../apache-resource-bundles/index.html">Resource Bundles</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><a name="gpg:sign-and-deploy-file"></a>gpg:sign-and-deploy-file</h2>
-
-<p><b>Full name</b>:</p>
-
-<p>org.apache.maven.plugins:maven-gpg-plugin:1.6:sign-and-deploy-file</p>
-
-<p><b>Description</b>:</p>
-
-<div>Signs artifacts and 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>
-
-<li>Since version: <tt>1.0-beta-4</tt>.</li>
- </ul>
-
-<div class="section">
-<h3><a name="Required_Parameters"></a>Required Parameters</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>1.0-beta-4</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>1.0-beta-4</tt></td>
-
-<td>Server Id to map on the <id> under <server> section of
-<tt>settings.xml</tt>. 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>1.0-beta-4</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><a name="Optional_Parameters"></a>Optional Parameters</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>1.0-beta-4</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="#ascDirectory">ascDirectory</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>1.0-beta-4</tt></td>
-
-<td>The directory where to store signature files.<br /><b>User property is</b>: <tt>gpg.ascDirectory</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#classifier">classifier</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.0-beta-4</tt></td>
-
-<td>Add classifier to the artifact<br /><b>User property is</b>: <tt>classifier</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#classifiers">classifiers</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.0-beta-4</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="b">
-
-<td><b><a href="#defaultKeyring">defaultKeyring</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>1.2</tt></td>
-
-<td>Whether to add the default keyrings from gpg's home directory to
-the list of used keyrings.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>gpg.defaultKeyring</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#description">description</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.0-beta-4</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="#executable">executable</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.1</tt></td>
-
-<td>The path to the GnuPG executable to use for artifact signing.
-Defaults to either "gpg" or "gpg.exe" depending on the operating
-system.<br /><b>User property is</b>: <tt>gpg.executable</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#files">files</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.0-beta-4</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="b">
-
-<td><b><a href="#generatePom">generatePom</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>1.0-beta-4</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="a">
-
-<td><b><a href="#gpgArguments">gpgArguments</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>1.5</tt></td>
-
-<td>Sets the arguments to be passed to gpg. Example:
-
-<div>
-<pre>
-<gpgArguments>
- <arg>--no-random-seed-file</arg>
- <arg>--no-permission-warning</arg>
-</gpgArguments>
-</pre></div><br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#groupId">groupId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.0-beta-4</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="#homedir">homedir</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>1.0</tt></td>
-
-<td>The directory from which gpg will load keyrings. If not specified,
-gpg will use the value configured for its installation, e.g.
-<tt>~/.gnupg</tt> or <tt>%APPDATA%/gnupg</tt>.<br /><b>User property is</b>: <tt>gpg.homedir</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#javadoc">javadoc</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>1.3</tt></td>
-
-<td>The bundled API docs for the artifact.<br /><b>User property is</b>: <tt>javadoc</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#keyname">keyname</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.0-beta-4</tt></td>
-
-<td>The "name" of the key to sign with. Passed to gpg as
-<tt>--local-user</tt>.<br /><b>User property is</b>: <tt>gpg.keyname</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#lockMode">lockMode</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.5</tt></td>
-
-<td>The lock mode to use when invoking gpg. By default no lock mode
-will be specified. Valid values are <tt>once</tt>,
-<tt>multiple</tt> and <tt>never</tt>. The lock mode gets
-translated into the corresponding <tt>--lock-___</tt> command
-line argument. Improper usage of this option may lead to data and
-key corruption.<br /><b>User property is</b>: <tt>gpg.lockMode</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#packaging">packaging</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.0-beta-4</tt></td>
-
-<td>Type of the artifact to be deployed. Retrieved from POM file if
-specified. Defaults to file extension if not specified via command
-line or POM.<br /><b>User property is</b>: <tt>packaging</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#passphrase">passphrase</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.0-beta-4</tt></td>
-
-<td>The passphrase to use when signing. If not given, look up the value
-under Maven settings using server id at 'passphraseServerKey'
-configuration.<br /><b>User property is</b>: <tt>gpg.passphrase</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#passphraseServerId">passphraseServerId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.6</tt></td>
-
-<td>Server id to lookup the passphrase under Maven settings.<br /><b>Default value is</b>: <tt>gpg.passphrase</tt>.<br /><b>User property is</b>: <tt>gpg.passphraseServerId</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#pomFile">pomFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>1.0-beta-4</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="a">
-
-<td><b><a href="#publicKeyring">publicKeyring</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.2</tt></td>
-
-<td>The path to a public keyring to add to the list of keyrings. By
-default, only the <tt>pubring.gpg</tt> from gpg's home
-directory is considered. Use this option (and
-<tt>defaultKeyring</tt> if required) to use a different public
-key. <i>Note:</i> Relative paths are resolved against gpg's home
-directory, not the project base directory.<br /><b>User property is</b>: <tt>gpg.publicKeyring</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#repositoryLayout">repositoryLayout</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.0-beta-4</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>1.3</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="#secretKeyring">secretKeyring</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.2</tt></td>
-
-<td>The path to a secret keyring to add to the list of keyrings. By
-default, only the <tt>secring.gpg</tt> from gpg's home
-directory is considered. Use this option (in combination with
-<tt>publicKeyring</tt> and <tt>defaultKeyring</tt> if
-required) to use a different secret key. <i>Note:</i> Relative
-paths are resolved against gpg's home directory, not the project
-base directory.<br /><b>User property is</b>: <tt>gpg.secretKeyring</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#sources">sources</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>1.3</tt></td>
-
-<td>The bundled sources for the artifact.<br /><b>User property is</b>: <tt>sources</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#types">types</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.0-beta-4</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="a">
-
-<td><b><a href="#uniqueVersion">uniqueVersion</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>1.0-beta-4</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="b">
-
-<td><b><a href="#updateReleaseInfo">updateReleaseInfo</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>1.3</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="a">
-
-<td><b><a href="#useAgent">useAgent</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>1.0-beta-4</tt></td>
-
-<td>Passes <tt>--use-agent</tt> or <tt>--no-use-agent</tt> to
-gpg. If using an agent, the passphrase is optional as the agent
-will provide it. For gpg2, specify true as --no-use-agent was
-removed in gpg2 and doesn't ask for a passphrase anymore.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>gpg.useagent</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#version">version</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>1.0-beta-4</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><a name="Parameter_Details"></a>Parameter Details</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>Since</b>: <tt>1.0-beta-4</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="ascDirectory">ascDirectory</a>:</b></p>
-
-<div>The directory where to store signature files.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Since</b>: <tt>1.0-beta-4</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>gpg.ascDirectory</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>Since</b>: <tt>1.0-beta-4</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>Since</b>: <tt>1.0-beta-4</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="defaultKeyring">defaultKeyring</a>:</b></p>
-
-<div>Whether to add the default keyrings from gpg's home directory to
-the list of used keyrings.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Since</b>: <tt>1.2</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>gpg.defaultKeyring</tt></li>
-
-<li><b>Default</b>: <tt>true</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>Since</b>: <tt>1.0-beta-4</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="executable">executable</a>:</b></p>
-
-<div>The path to the GnuPG executable to use for artifact signing.
-Defaults to either "gpg" or "gpg.exe" depending on the operating
-system.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Since</b>: <tt>1.1</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>gpg.executable</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>Since</b>: <tt>1.0-beta-4</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>Since</b>: <tt>1.0-beta-4</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>Since</b>: <tt>1.0-beta-4</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="gpgArguments">gpgArguments</a>:</b></p>
-
-<div>Sets the arguments to be passed to gpg. Example:
-
-<div>
-<pre>
-<gpgArguments>
- <arg>--no-random-seed-file</arg>
- <arg>--no-permission-warning</arg>
-</gpgArguments>
-</pre></div></div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Since</b>: <tt>1.5</tt></li>
-
-<li><b>Required</b>: <tt>No</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>Since</b>: <tt>1.0-beta-4</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="homedir">homedir</a>:</b></p>
-
-<div>The directory from which gpg will load keyrings. If not specified,
-gpg will use the value configured for its installation, e.g.
-<tt>~/.gnupg</tt> or <tt>%APPDATA%/gnupg</tt>.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Since</b>: <tt>1.0</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>gpg.homedir</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>1.3</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="keyname">keyname</a>:</b></p>
-
-<div>The "name" of the key to sign with. Passed to gpg as
-<tt>--local-user</tt>.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Since</b>: <tt>1.0-beta-4</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>gpg.keyname</tt></li>
- </ul><hr />
-<p><b><a name="lockMode">lockMode</a>:</b></p>
-
-<div>The lock mode to use when invoking gpg. By default no lock mode
-will be specified. Valid values are <tt>once</tt>,
-<tt>multiple</tt> and <tt>never</tt>. The lock mode gets
-translated into the corresponding <tt>--lock-___</tt> command
-line argument. Improper usage of this option may lead to data and
-key corruption.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Since</b>: <tt>1.5</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>gpg.lockMode</tt></li>
- </ul><hr />
-<p><b><a name="packaging">packaging</a>:</b></p>
-
-<div>Type of the artifact to be deployed. Retrieved from POM file if
-specified. Defaults to file extension if not specified via command
-line or POM.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Since</b>: <tt>1.0-beta-4</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="passphrase">passphrase</a>:</b></p>
-
-<div>The passphrase to use when signing. If not given, look up the value
-under Maven settings using server id at 'passphraseServerKey'
-configuration.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Since</b>: <tt>1.0-beta-4</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>gpg.passphrase</tt></li>
- </ul><hr />
-<p><b><a name="passphraseServerId">passphraseServerId</a>:</b></p>
-
-<div>Server id to lookup the passphrase under Maven settings.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Since</b>: <tt>1.6</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>gpg.passphraseServerId</tt></li>
-
-<li><b>Default</b>: <tt>gpg.passphrase</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>Since</b>: <tt>1.0-beta-4</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="publicKeyring">publicKeyring</a>:</b></p>
-
-<div>The path to a public keyring to add to the list of keyrings. By
-default, only the <tt>pubring.gpg</tt> from gpg's home
-directory is considered. Use this option (and
-<tt>defaultKeyring</tt> if required) to use a different public
-key. <i>Note:</i> Relative paths are resolved against gpg's home
-directory, not the project base directory.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Since</b>: <tt>1.2</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>gpg.publicKeyring</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
-<tt>settings.xml</tt>. In most cases, this parameter will be
-required for authentication.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Since</b>: <tt>1.0-beta-4</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>Since</b>: <tt>1.0-beta-4</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>1.3</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="secretKeyring">secretKeyring</a>:</b></p>
-
-<div>The path to a secret keyring to add to the list of keyrings. By
-default, only the <tt>secring.gpg</tt> from gpg's home
-directory is considered. Use this option (in combination with
-<tt>publicKeyring</tt> and <tt>defaultKeyring</tt> if
-required) to use a different secret key. <i>Note:</i> Relative
-paths are resolved against gpg's home directory, not the project
-base directory.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Since</b>: <tt>1.2</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>gpg.secretKeyring</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>1.3</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>Since</b>: <tt>1.0-beta-4</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>Since</b>: <tt>1.0-beta-4</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>Since</b>: <tt>1.3</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>Since</b>: <tt>1.0-beta-4</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="useAgent">useAgent</a>:</b></p>
-
-<div>Passes <tt>--use-agent</tt> or <tt>--no-use-agent</tt> to
-gpg. If using an agent, the passphrase is optional as the agent
-will provide it. For gpg2, specify true as --no-use-agent was
-removed in gpg2 and doesn't ask for a passphrase anymore.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Since</b>: <tt>1.0-beta-4</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>gpg.useagent</tt></li>
-
-<li><b>Default</b>: <tt>true</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>Since</b>: <tt>1.0-beta-4</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">
- © 2002-2015
- 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>
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from target/generated-site/xdoc/sign-and-deploy-file-mojo.xml at 2020-04-12
+ | Rendered using Apache Maven Fluido Skin 1.7
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20200412" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Maven GPG Plugin – gpg:sign-and-deploy-file</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script>
+ <!-- Google Analytics -->
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-140879-1']);
+ _gaq.push(['_trackPageview']);
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+ </head>
+ <body class="topBarDisabled">
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left"><a href="https://www.apache.org/" id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven GPG Plugin"/></a></div>
+ <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt=""/></a></div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+ <li class=""><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
+ <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
+ <li class=""><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li>
+ <li class=""><a href="index.html" title="Apache Maven GPG Plugin">Apache Maven GPG Plugin</a><span class="divider">/</span></li>
+ <li class="active ">gpg:sign-and-deploy-file</li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2020-04-12</li>
+ <li id="projectVersion" class="pull-right">Version: 3.0.0</li>
+ </ul>
+ </div>
+ <div class="row-fluid">
+ <div id="leftColumn" class="span2">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+ <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a></li>
+ <li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</a></li>
+ <li><a href="usage.html" title="Usage"><span class="none"></span>Usage</a></li>
+ <li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li>
+ <li><a href="http://www.apache.org/licenses/" class="externalLink" title="License"><span class="none"></span>License</a></li>
+ <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li>
+ <li class="nav-header">Examples</li>
+ <li><a href="examples/deploy-signed-artifacts.html" title="Deploy Signed Artifacts"><span class="none"></span>Deploy Signed Artifacts</a></li>
+ <li class="nav-header">Project Documentation</li>
+ <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li>
+ <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li>
+ <li class="nav-header">Maven Projects</li>
+ <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li>
+ <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li>
+ <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li>
+ <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li>
+ <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li>
+ <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li>
+ <li><a href="../index.html" title="Plugins"><span class="none"></span>Plugins</a></li>
+ <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li>
+ <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li>
+ <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li>
+ <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li>
+ <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li>
+ <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li>
+ <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li>
+ <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li>
+ <li class="nav-header">ASF</li>
+ <li><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li>
+ <li><a href="https://www.apache.org/foundation/" class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li>
+ <li><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li>
+ <li><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li>
+</ul>
+<form id="search-form" action="https://www.google.com/search" method="get" >
+ <input value="maven.apache.org/plugins/maven-gpg-plugin/" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script>
+ <hr />
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div id="twitter">
+ <a href="https://twitter.com/ASFMavenProject" class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a>
+ <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+ </div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
+ </div>
+ </div>
+ </div>
+ <div id="bodyColumn" class="span10" >
+
+
+ <div class="section">
+<h2><a name="gpg:sign-and-deploy-file"></a>gpg:sign-and-deploy-file</h2>
+
+<p><b>Full name</b>:</p>
+
+<p>org.apache.maven.plugins:maven-gpg-plugin:3.0.0:sign-and-deploy-file</p>
+
+<p><b>Description</b>:</p>
+
+<div>Signs artifacts and installs the artifact in the remote repository.</div>
+
+<p><b>Attributes</b>:</p>
+
+<ul>
+
+<li>Since version: <tt>1.0-beta-4</tt>.</li>
+ </ul>
+
+<div class="section">
+<h3><a name="Required_Parameters"></a>Required Parameters</h3>
+
+<table class="table table-striped" border="0">
+
+<tr class="a">
+
+<th>Name</th>
+
+<th>Type</th>
+
+<th>Since</th>
+
+<th>Description</th>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#file"><file></a></tt></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>1.0-beta-4</tt></td>
+
+<td>File to be deployed.<br /><b>User property is</b>: <tt>file</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#repositoryId"><repositoryId></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</tt></td>
+
+<td>Server Id to map on the <id> under <server> section of
+<tt>settings.xml</tt>. 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>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#url"><url></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</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>.<br /></td>
+ </tr>
+ </table>
+ </div>
+
+<div class="section">
+<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
+
+<table class="table table-striped" border="0">
+
+<tr class="a">
+
+<th>Name</th>
+
+<th>Type</th>
+
+<th>Since</th>
+
+<th>Description</th>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#artifactId"><artifactId></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</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>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#ascDirectory"><ascDirectory></a></tt></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>1.0-beta-4</tt></td>
+
+<td>The directory where to store signature files.<br /><b>User property is</b>: <tt>gpg.ascDirectory</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#classifier"><classifier></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</tt></td>
+
+<td>Add classifier to the artifact<br /><b>User property is</b>: <tt>classifier</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#classifiers"><classifiers></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</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>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#defaultKeyring"><defaultKeyring></a></tt></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>1.2</tt></td>
+
+<td>Whether to add the default keyrings from gpg's home directory to
+the list of used keyrings.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>gpg.defaultKeyring</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#description"><description></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</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>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#executable"><executable></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.1</tt></td>
+
+<td>The path to the GnuPG executable to use for artifact signing.
+Defaults to either "gpg" or "gpg.exe" depending on the operating
+system.<br /><b>User property is</b>: <tt>gpg.executable</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#files"><files></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</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>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#generatePom"><generatePom></a></tt></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>1.0-beta-4</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>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#gpgArguments"><gpgArguments></a></tt></td>
+
+<td><tt>List</tt></td>
+
+<td><tt>1.5</tt></td>
+
+<td>Sets the arguments to be passed to gpg. Example:
+
+<div>
+<pre>
+<gpgArguments>
+ <arg>--no-random-seed-file</arg>
+ <arg>--no-permission-warning</arg>
+</gpgArguments>
+</pre></div><br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#groupId"><groupId></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</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>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#homedir"><homedir></a></tt></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>1.0</tt></td>
+
+<td>The directory from which gpg will load keyrings. If not specified,
+gpg will use the value configured for its installation, e.g.
+<tt>~/.gnupg</tt> or <tt>%APPDATA%/gnupg</tt>.<br /><b>User property is</b>: <tt>gpg.homedir</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#javadoc"><javadoc></a></tt></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>1.3</tt></td>
+
+<td>The bundled API docs for the artifact.<br /><b>User property is</b>: <tt>javadoc</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#keyname"><keyname></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</tt></td>
+
+<td>The "name" of the key to sign with. Passed to gpg as
+<tt>--local-user</tt>.<br /><b>User property is</b>: <tt>gpg.keyname</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#lockMode"><lockMode></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.5</tt></td>
+
+<td>The lock mode to use when invoking gpg. By default no lock mode
+will be specified. Valid values are <tt>once</tt>,
+<tt>multiple</tt> and <tt>never</tt>. The lock mode gets
+translated into the corresponding <tt>--lock-___</tt> command
+line argument. Improper usage of this option may lead to data and
+key corruption.<br /><b>User property is</b>: <tt>gpg.lockMode</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#packaging"><packaging></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</tt></td>
+
+<td>Type of the artifact to be deployed. Retrieved from POM file if
+specified. Defaults to file extension if not specified via command
+line or POM.<br /><b>User property is</b>: <tt>packaging</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#passphrase"><passphrase></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</tt></td>
+
+<td>The passphrase to use when signing. If not given, look up the value
+under Maven settings using server id at 'passphraseServerKey'
+configuration.<br /><b>User property is</b>: <tt>gpg.passphrase</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#passphraseServerId"><passphraseServerId></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.6</tt></td>
+
+<td>Server id to lookup the passphrase under Maven settings.<br /><b>Default value is</b>: <tt>gpg.passphrase</tt>.<br /><b>User property is</b>: <tt>gpg.passphraseServerId</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#pomFile"><pomFile></a></tt></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>1.0-beta-4</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>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#publicKeyring"><publicKeyring></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.2</tt></td>
+
+<td>The path to a public keyring to add to the list of keyrings. By
+default, only the <tt>pubring.gpg</tt> from gpg's home
+directory is considered. Use this option (and
+<tt>defaultKeyring</tt> if required) to use a different public
+key. <i>Note:</i> Relative paths are resolved against gpg's home
+directory, not the project base directory.<br /><b>User property is</b>: <tt>gpg.publicKeyring</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#repositoryLayout"><repositoryLayout></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</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>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#retryFailedDeploymentCount"><retryFailedDeploymentCount></a></tt></td>
+
+<td><tt>int</tt></td>
+
+<td><tt>1.3</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>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#secretKeyring"><secretKeyring></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.2</tt></td>
+
+<td>
+<p>The path to a secret keyring to add to the list of keyrings. By
+default, only the <tt>secring.gpg</tt> from gpg's home
+directory is considered. Use this option (in combination with
+<tt>publicKeyring</tt> and <tt>defaultKeyring</tt> if
+required) to use a different secret key. <i>Note:</i> Relative
+paths are resolved against gpg's home directory, not the project
+base directory.</p>
+<b>NOTE:</b> As of gpg 2.1 this is an obsolete option and
+ignored. All secret keys are stored in the 'private-keys-v1.d'
+directory below the GnuPG home directory.<br /><b>User property is</b>: <tt>gpg.secretKeyring</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#sources"><sources></a></tt></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>1.3</tt></td>
+
+<td>The bundled sources for the artifact.<br /><b>User property is</b>: <tt>sources</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#types"><types></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</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>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#updateReleaseInfo"><updateReleaseInfo></a></tt></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>1.3</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>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><tt><a href="#useAgent"><useAgent></a></tt></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>1.0-beta-4</tt></td>
+
+<td>Passes <tt>--use-agent</tt> or <tt>--no-use-agent</tt> to
+gpg. If using an agent, the passphrase is optional as the agent
+will provide it. For gpg2, specify true as --no-use-agent was
+removed in gpg2 and doesn't ask for a passphrase anymore.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>gpg.useagent</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><tt><a href="#version"><version></a></tt></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>1.0-beta-4</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>.<br /></td>
+ </tr>
+ </table>
+ </div>
+
+<div class="section">
+<h3><a name="Parameter_Details"></a>Parameter Details</h3>
+
+<div class="section">
+<h4><a name="a.3CartifactId.3E"></a><b><a name="artifactId"><artifactId></a></b></h4>
+
+<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>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>artifactId</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3CascDirectory.3E"></a><b><a name="ascDirectory"><ascDirectory></a></b></h4>
+
+<div>The directory where to store signature files.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>gpg.ascDirectory</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Cclassifier.3E"></a><b><a name="classifier"><classifier></a></b></h4>
+
+<div>Add classifier to the artifact</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>classifier</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Cclassifiers.3E"></a><b><a name="classifiers"><classifiers></a></b></h4>
+
+<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>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>classifiers</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3CdefaultKeyring.3E"></a><b><a name="defaultKeyring"><defaultKeyring></a></b></h4>
+
+<div>Whether to add the default keyrings from gpg's home directory to
+the list of used keyrings.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>1.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>gpg.defaultKeyring</tt></li>
+
+<li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Cdescription.3E"></a><b><a name="description"><description></a></b></h4>
+
+<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>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>generatePom.description</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Cexecutable.3E"></a><b><a name="executable"><executable></a></b></h4>
+
+<div>The path to the GnuPG executable to use for artifact signing.
+Defaults to either "gpg" or "gpg.exe" depending on the operating
+system.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>1.1</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>gpg.executable</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Cfile.3E"></a><b><a name="file"><file></a></b></h4>
+
+<div>File to be deployed.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>Yes</tt></li>
+
+<li><b>User Property</b>: <tt>file</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Cfiles.3E"></a><b><a name="files"><files></a></b></h4>
+
+<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>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>files</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3CgeneratePom.3E"></a><b><a name="generatePom"><generatePom></a></b></h4>
+
+<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>Since</b>: <tt>1.0-beta-4</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 /></div>
+<div class="section">
+<h4><a name="a.3CgpgArguments.3E"></a><b><a name="gpgArguments"><gpgArguments></a></b></h4>
+
+<div>Sets the arguments to be passed to gpg. Example:
+
+<div>
+<pre>
+<gpgArguments>
+ <arg>--no-random-seed-file</arg>
+ <arg>--no-permission-warning</arg>
+</gpgArguments>
+</pre></div></div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.util.List</tt></li>
+
+<li><b>Since</b>: <tt>1.5</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3CgroupId.3E"></a><b><a name="groupId"><groupId></a></b></h4>
+
+<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>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>groupId</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Chomedir.3E"></a><b><a name="homedir"><homedir></a></b></h4>
+
+<div>The directory from which gpg will load keyrings. If not specified,
+gpg will use the value configured for its installation, e.g.
+<tt>~/.gnupg</tt> or <tt>%APPDATA%/gnupg</tt>.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Since</b>: <tt>1.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>gpg.homedir</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Cjavadoc.3E"></a><b><a name="javadoc"><javadoc></a></b></h4>
+
+<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>1.3</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>javadoc</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Ckeyname.3E"></a><b><a name="keyname"><keyname></a></b></h4>
+
+<div>The "name" of the key to sign with. Passed to gpg as
+<tt>--local-user</tt>.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>gpg.keyname</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3ClockMode.3E"></a><b><a name="lockMode"><lockMode></a></b></h4>
+
+<div>The lock mode to use when invoking gpg. By default no lock mode
+will be specified. Valid values are <tt>once</tt>,
+<tt>multiple</tt> and <tt>never</tt>. The lock mode gets
+translated into the corresponding <tt>--lock-___</tt> command
+line argument. Improper usage of this option may lead to data and
+key corruption.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>1.5</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>gpg.lockMode</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Cpackaging.3E"></a><b><a name="packaging"><packaging></a></b></h4>
+
+<div>Type of the artifact to be deployed. Retrieved from POM file if
+specified. Defaults to file extension if not specified via command
+line or POM.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>packaging</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Cpassphrase.3E"></a><b><a name="passphrase"><passphrase></a></b></h4>
+
+<div>The passphrase to use when signing. If not given, look up the value
+under Maven settings using server id at 'passphraseServerKey'
+configuration.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>gpg.passphrase</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3CpassphraseServerId.3E"></a><b><a name="passphraseServerId"><passphraseServerId></a></b></h4>
+
+<div>Server id to lookup the passphrase under Maven settings.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>1.6</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>gpg.passphraseServerId</tt></li>
+
+<li><b>Default</b>: <tt>gpg.passphrase</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3CpomFile.3E"></a><b><a name="pomFile"><pomFile></a></b></h4>
+
+<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>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>pomFile</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3CpublicKeyring.3E"></a><b><a name="publicKeyring"><publicKeyring></a></b></h4>
+
+<div>The path to a public keyring to add to the list of keyrings. By
+default, only the <tt>pubring.gpg</tt> from gpg's home
+directory is considered. Use this option (and
+<tt>defaultKeyring</tt> if required) to use a different public
+key. <i>Note:</i> Relative paths are resolved against gpg's home
+directory, not the project base directory.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>1.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>gpg.publicKeyring</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3CrepositoryId.3E"></a><b><a name="repositoryId"><repositoryId></a></b></h4>
+
+<div>Server Id to map on the <id> under <server> section of
+<tt>settings.xml</tt>. In most cases, this parameter will be
+required for authentication.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>1.0-beta-4</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 /></div>
+<div class="section">
+<h4><a name="a.3CrepositoryLayout.3E"></a><b><a name="repositoryLayout"><repositoryLayout></a></b></h4>
+
+<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>Since</b>: <tt>1.0-beta-4</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 /></div>
+<div class="section">
+<h4><a name="a.3CretryFailedDeploymentCount.3E"></a><b><a name="retryFailedDeploymentCount"><retryFailedDeploymentCount></a></b></h4>
+
+<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>1.3</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 /></div>
+<div class="section">
+<h4><a name="a.3CsecretKeyring.3E"></a><b><a name="secretKeyring"><secretKeyring></a></b></h4>
+
+<div>
+<p>The path to a secret keyring to add to the list of keyrings. By
+default, only the <tt>secring.gpg</tt> from gpg's home
+directory is considered. Use this option (in combination with
+<tt>publicKeyring</tt> and <tt>defaultKeyring</tt> if
+required) to use a different secret key. <i>Note:</i> Relative
+paths are resolved against gpg's home directory, not the project
+base directory.</p>
+<b>NOTE:</b> As of gpg 2.1 this is an obsolete option and
+ignored. All secret keys are stored in the 'private-keys-v1.d'
+directory below the GnuPG home directory.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>1.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>gpg.secretKeyring</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Csources.3E"></a><b><a name="sources"><sources></a></b></h4>
+
+<div>The bundled sources for the artifact.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Since</b>: <tt>1.3</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>sources</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Ctypes.3E"></a><b><a name="types"><types></a></b></h4>
+
+<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>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>types</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3CupdateReleaseInfo.3E"></a><b><a name="updateReleaseInfo"><updateReleaseInfo></a></b></h4>
+
+<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>Since</b>: <tt>1.3</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 /></div>
+<div class="section">
+<h4><a name="a.3Curl.3E"></a><b><a name="url"><url></a></b></h4>
+
+<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>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>Yes</tt></li>
+
+<li><b>User Property</b>: <tt>url</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3CuseAgent.3E"></a><b><a name="useAgent"><useAgent></a></b></h4>
+
+<div>Passes <tt>--use-agent</tt> or <tt>--no-use-agent</tt> to
+gpg. If using an agent, the passphrase is optional as the agent
+will provide it. For gpg2, specify true as --no-use-agent was
+removed in gpg2 and doesn't ask for a passphrase anymore.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>1.0-beta-4</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>gpg.useagent</tt></li>
+
+<li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr /></div>
+<div class="section">
+<h4><a name="a.3Cversion.3E"></a><b><a name="version"><version></a></b></h4>
+
+<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>Since</b>: <tt>1.0-beta-4</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>
+ </div>
+ <hr/>
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p>Copyright ©2002–2020
+<a href="https://www.apache.org/">The Apache Software Foundation</a>.
+All rights reserved.</p>
+ </div>
+ </div>
+ </footer>
+ </body>
</html>
\ No newline at end of file