05c6d923f9
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@529099 13f79535-47bb-0310-9956-ffa450edef68
310 lines
10 KiB
XML
310 lines
10 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!--
|
|
/*
|
|
* Copyright 2001-2004 The Apache Software Foundation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
-->
|
|
|
|
<document>
|
|
|
|
<properties>
|
|
<title>Properties</title>
|
|
<author email="michal.maczka@dimatics.com">Michal Maczka</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Maven Artifact Plugin Settings">
|
|
<table>
|
|
<tr>
|
|
<th>Property name</th>
|
|
<th>Description</th>
|
|
<th>Optional?</th>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.list</td>
|
|
<td>
|
|
The list of comma separated names of the repositories to which artifacts produced by the project will be
|
|
deployed. E.g.:
|
|
<br />
|
|
<i>maven.repo.list=myrepo1,ibiblio</i>
|
|
<br />
|
|
The names of all other properties are constructed using the entries present in this list. Below the set of
|
|
properties which can be used for configuration of deployment process to each of the repositories provided in
|
|
the list.
|
|
<i>x</i>
|
|
in the names of those properties should be replaced by actual repository name (like
|
|
<i>ibiblio</i>
|
|
). In case of doubts see an
|
|
<a href="examples.html">example</a>
|
|
</td>
|
|
<td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x</td>
|
|
<td>
|
|
Specifies the URL of remote repository. The URL should contain the protocol name.
|
|
<br />
|
|
See the
|
|
<a href="protocols.html">the list</a>
|
|
of supported protocols.
|
|
<br />
|
|
x corresponds to repository name defined using
|
|
<i>maven.repo.list</i>
|
|
property.
|
|
</td>
|
|
<td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.directory</td>
|
|
<td>The path on the remote file system where artifacts will be placed</td>
|
|
<td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.username</td>
|
|
<td>
|
|
The user name that will be used to authenticated user if access to repository requires authentication.
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.password</td>
|
|
<td>
|
|
The password which will be used to authenticate user.
|
|
<br />
|
|
If server/protocol supports authentication via both private/public keys and password, it will first try to
|
|
use keys for authentication and if that doesn't work then will fall back to using the username and password
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.group</td>
|
|
<td>The remote group (UNIX group) to which the artifact will belong after it is deployed</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.mode</td>
|
|
<td>
|
|
The remote file mode (UNIX permissions) to which the artifact will be set to after it is deployed. Default
|
|
is
|
|
<code>g+w</code>
|
|
.
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.directory.mode</td>
|
|
<td>
|
|
The remote directory mode (UNIX permissions) when directories are created while deploying the artifact.
|
|
Default is
|
|
<code>maven.repo.x.mode</code>
|
|
.
|
|
<b>Warning:</b>
|
|
if you are using an octal file permission, you should not use the default value for this as you should add
|
|
the executable permission for directories.
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.privatekey</td>
|
|
<td>
|
|
The absolute path to private key file.
|
|
<br />
|
|
Thie is used only for when protocol supports authentication via private/public key pair.
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.passphrase</td>
|
|
<td>The passphrase used to decrypt private key file</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.compress</td>
|
|
<td>Used by scp if you want to compress the stream.</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section name="Protocol-specific Properties">
|
|
<subsection name="scpexe">
|
|
<table>
|
|
<tr>
|
|
<th>Property name</th>
|
|
<th>Description</th>
|
|
<th>Optional?</th>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.scp.executable</td>
|
|
<td>
|
|
Specifies the name (and possibly location) of the remote secure copy executable to use (SCP). The default
|
|
value is
|
|
<code>maven.scp.executable</code>
|
|
.
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.scp.args</td>
|
|
<td>Specifies optional parameters that are passed to the scp executable.</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.ssh.executable</td>
|
|
<td>
|
|
Specifies the name (and possibly location) of the remote secure shell executable to use (SSH). The default
|
|
value is
|
|
<code>maven.ssh.executable</code>
|
|
.
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.ssh.args</td>
|
|
<td>Specifies optional parameters that are passed to the ssh executable.</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.repo.x.port</td>
|
|
<td>This property has no effect with scpexe protocol, use args instead.</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
</table>
|
|
</subsection>
|
|
</section>
|
|
<section name="Generate a code signing key (OpenPGP Compatible Signature)">
|
|
<p>
|
|
The artifact plugin allows to automatically sign your artifacts with GPG when you deploy a release. You'll find
|
|
more informations about signing releases here :
|
|
<a href="http://www.apache.org/dev/release-signing.html">http://www.apache.org/dev/release-signing.html</a>
|
|
</p>
|
|
<p>
|
|
You have to install
|
|
<a href="http://www.gnupg.org/">GNU Privacy Guard</a>
|
|
for your your platform and add it in your PATH.
|
|
</p>
|
|
<table>
|
|
<tr>
|
|
<th>Property name</th>
|
|
<th>Description</th>
|
|
<th>Optional?</th>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.artifact.gpg.skip</td>
|
|
<td>
|
|
Do you want to skip the signing step? Default : true. Before to enable it you have to correctly setup GPG.
|
|
You need to have a key and
|
|
<code>gpg</code>
|
|
must be in your PATH.
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.artifact.gpg.passphrase</td>
|
|
<td>
|
|
The passphrase to use when signing. Default : not defined. If not defined and signing activated, the plugin
|
|
will prompt for the passphrase.
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.artifact.gpg.keyname</td>
|
|
<td>
|
|
The "name" of the key to sign with. Passed to gpg as
|
|
<code>--local-user</code>
|
|
. Default : not defined. The default key is used.
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.artifact.gpg.useagent</td>
|
|
<td>
|
|
Passes
|
|
<code>--use-agent</code>
|
|
or
|
|
<code>--no-use-agent</code>
|
|
to gpg. If using an agent, the password is optional as the agent will provide it. Default : false.
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section name="Other properties used">
|
|
<table>
|
|
<tr>
|
|
<th>Property name</th>
|
|
<th>Description</th>
|
|
<th>Optional?</th>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.artifact.deploy.timestamps</td>
|
|
<td>
|
|
Specifies whether timestamped versions of artifacts should be deployed as well when deploying SNAPSHOT
|
|
versions. Defaults to 'true'.
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
</table>
|
|
<p>
|
|
If you are behind a firewall and need to use a proxy server, check the
|
|
<a href="http://maven.apache.org/maven-1.x/reference/properties.html#Proxy_Properties">proxy properties</a>
|
|
.
|
|
</p>
|
|
</section>
|
|
<section name="Deploy Properties (DEPRECATED)">
|
|
<table>
|
|
<tr>
|
|
<th>Property name</th>
|
|
<th>Description</th>
|
|
<th>Optional?</th>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.scp.executable</td>
|
|
<td>
|
|
Specifies the name (and possibly location) of the remote secure copy executable to use (SCP). The default
|
|
value is
|
|
<code>scp</code>
|
|
(i.e. an executable named
|
|
<code>scp</code>
|
|
must be in your path).
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.scp.args</td>
|
|
<td>Specifies optional parameters that are passed to the scp executable.</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ssh.executable</td>
|
|
<td>
|
|
Specifies the name (and possibly location) of the remote secure shell executable to use (SSH). The default
|
|
value is
|
|
<code>ssh</code>
|
|
(i.e. an executable named
|
|
<code>ssh</code>
|
|
must be in your path).
|
|
</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ssh.args</td>
|
|
<td>Specifies optional parameters that are passed to the ssh executable.</td>
|
|
<td>Yes</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
</body>
|
|
</document>
|