Cleanup of doco by request.
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113543 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
1 parent
2002914171
commit
43beb52651
8 files changed
+53
-50
No files matched your search
@@ -2,12 +2,12 @@
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Maven Artifact Plugin Properties</title>
|
||||
<title>Authentication</title>
|
||||
<author email="michal.maczka@dimatics.com">Michal Maczka</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Key-based authentification">
|
||||
<section name="Key-based authentication">
|
||||
<p>
|
||||
In preparation
|
||||
</p>
|
||||
@@ -2,7 +2,7 @@
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Maven Artifact Plug-in Examples</title>
|
||||
<title>Examples</title>
|
||||
<author email="tma@netspace.net.au">Tim Anderson</author>
|
||||
</properties>
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<section name="Examples">
|
||||
<p>
|
||||
The following example demonstrates how to depoyment
|
||||
of artifact to remote repsoitories can be configured.
|
||||
of artifact to remote repositories can be configured.
|
||||
|
||||
<source><![CDATA[
|
||||
#list of repositories to which we will deploy.
|
||||
@@ -35,8 +35,8 @@ maven.repo.R2.group=Michal
|
||||
maven.repo.R3=scp://host3.com
|
||||
maven.repo.R3.username=michal
|
||||
maven.repo.R3.directory=repo
|
||||
maven.repo.R3.group=remote_grup
|
||||
maven.repo.R3.privatekey=/home/.ssh/id_dsa
|
||||
maven.repo.R3.group=remote_group
|
||||
maven.repo.R3.privatekey=/home/michal/.ssh/id_dsa
|
||||
|
||||
#settings for repository 'R4'
|
||||
maven.repo.R4=file://c:\\temp
|
||||
|
||||
@@ -2,21 +2,22 @@
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Maven Artifact Plugin Properties</title>
|
||||
<title>Overview</title>
|
||||
<author email="michal.maczka@dimatics.com">Michal Maczka</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Maven Artifact Plugin ">
|
||||
<subsection name="Overview of the Maven Arifact Plug-in Reference Documentation">
|
||||
<subsection name="Overview of the Maven Artifact Plugin Reference Documentation">
|
||||
<p>
|
||||
This plugin generates java sources from schemas using Castor.
|
||||
This plugin allows a client program / user to upload artifacts to a remote
|
||||
repository using a variety of different protocols.
|
||||
</p>
|
||||
<table>
|
||||
<tr><th>Document</th><th>Description</th></tr>
|
||||
<tr><td><a href="properties.html">Properties</a></td>
|
||||
<td>
|
||||
The behavior of the Maven Artifact Plug-in can be altered via
|
||||
The behavior of the Maven Artifact Plugin can be altered via
|
||||
several properties. This document describes each property
|
||||
available, and the default used.
|
||||
</td>
|
||||
|
||||
@@ -8,13 +8,14 @@
|
||||
<item name="Maven" href="http://maven.apache.org/"/>
|
||||
</links>
|
||||
<menu name="Overview">
|
||||
<item name="Goals" href="/goals.html" />
|
||||
<item name="Overview" href="/index.html" />
|
||||
<!--item name="Goals" href="/goals.html" /-->
|
||||
<item name="Properties" href="/properties.html" />
|
||||
<item name="Tags" href="/tags.html" />
|
||||
<item name="Examples" href="/examples.html" />
|
||||
<item name="Supported Protocols" href="/protocols.html" />
|
||||
<item name="Security Considerations" href="/security.html" />
|
||||
<item name="Key-based Authentification" href="/authentification.html" />
|
||||
<item name="Key-based Authentication" href="/authentication.html" />
|
||||
</menu>
|
||||
</body>
|
||||
</project>
|
||||
@@ -2,7 +2,7 @@
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Maven Artifact Plugin Properties</title>
|
||||
<title>Properties</title>
|
||||
<author email="michal.maczka@dimatics.com">Michal Maczka</author>
|
||||
</properties>
|
||||
|
||||
@@ -50,29 +50,29 @@
|
||||
<tr>
|
||||
<td>maven.repo.x.directory</td>
|
||||
<td>
|
||||
The path at remote file system where artifacts will be put
|
||||
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 which will be used to authetificated
|
||||
user if access to repository requires authentification.
|
||||
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 authetificate
|
||||
The password which will be used to authenticate
|
||||
user.
|
||||
<br/>
|
||||
If server/protocol supports authetification via
|
||||
If server/protocol supports authentication via
|
||||
both private/public keys and password,
|
||||
first will try to use keys for authentication
|
||||
it will first try to use keys for authentication
|
||||
and if that doesn't work then
|
||||
we fall back to using the username and password
|
||||
will fall back to using the username and password
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
@@ -88,10 +88,10 @@
|
||||
<tr>
|
||||
<td>maven.repo.x.privatekey</td>
|
||||
<td>
|
||||
The absoluth path to private key file.
|
||||
The absolute path to private key file.
|
||||
<br/>
|
||||
Thie is used only for when protocol
|
||||
supports authetification via private/public
|
||||
supports authetication via private/public
|
||||
key pair.
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Maven Artifact Plugin Properties</title>
|
||||
<title>Protocols</title>
|
||||
<author email="michal.maczka@dimatics.com">Michal Maczka</author>
|
||||
</properties>
|
||||
|
||||
@@ -32,7 +32,7 @@
|
||||
<td>Optional</td>
|
||||
<td>Optional</td>
|
||||
<td>Optional</td>
|
||||
<td>Optional (deafult is 22)</td>
|
||||
<td>Optional (default is 22)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@@ -42,11 +42,11 @@
|
||||
<td>sftp://</td>
|
||||
<td>Mandatory</td>
|
||||
<td>Mandatory</td>
|
||||
<td>Mandatory if private key unless private key is provided</td>
|
||||
<td>Mandatory unless private key is provided</td>
|
||||
<td>Optional</td>
|
||||
<td>Optional</td>
|
||||
<td>Optional</td>
|
||||
<td>Optional (deafult is 22)</td>
|
||||
<td>Optional (default is 22)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>FTP</b></td>
|
||||
@@ -57,7 +57,7 @@
|
||||
<td>Not supported</td>
|
||||
<td>Not supported</td>
|
||||
<td>Not supported</td>
|
||||
<td>Optional (deafult is 21)</td>
|
||||
<td>Optional (default is 21)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>FILE</b></td>
|
||||
|
||||
@@ -2,12 +2,12 @@
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Maven Artifact Plug-in Examples</title>
|
||||
<author email="tma@netspace.net.au">Tim Anderson</author>
|
||||
<title>Security Considerations</title>
|
||||
<author email="michal.maczka@dimatics.com">Michal Maczka</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Securiry consideration">
|
||||
<section name="Security Considerations">
|
||||
<p>
|
||||
|
||||
<source><![CDATA[
|
||||
|
||||
+21
-20
@@ -2,8 +2,8 @@
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Maven Castor Plug-in Tags</title>
|
||||
<author email="tma@netspace.net.au">Tim Anderson</author>
|
||||
<title>Tags</title>
|
||||
<author email="michal.maczka@dimatics.com">Michal Maczka</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
@@ -19,11 +19,11 @@
|
||||
<table>
|
||||
<tr><th>Name</th><th>Description</th></tr>
|
||||
<tr>
|
||||
<td><a href="#artifact:deploy">artifact:delpoy</a></td>
|
||||
<td><a href="#artifact:deploy">artifact:deploy</a></td>
|
||||
<td>Deploy artifact to remote repository(ies)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#artifact:deploy-snapshot">artifact:delpoy-snapshot</a></td>
|
||||
<td><a href="#artifact:deploy-snapshot">artifact:deploy-snapshot</a></td>
|
||||
<td>Deploy snapshot version of artifact to remote repository</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -68,13 +68,13 @@
|
||||
<td>
|
||||
The project (POM) which produced artifact which will be deployed.
|
||||
<br/>
|
||||
POM contatins a bunch of settings (variables and context properties)
|
||||
which must be conulted in order to deploy artifact to repsoitories(s).
|
||||
Those settings include:
|
||||
The POM contains settings (variables and context properties)
|
||||
that must be consulted in order to deploy artifact to a repository.
|
||||
These settings include:
|
||||
<ol>
|
||||
<li>List of remote repositories where artifact will be deployed</li>
|
||||
<li>artifactId, groupId, version</li>
|
||||
<li>Individual settings of each repository</li>
|
||||
<li>Individual settings for each repository</li>
|
||||
<li>Proxy server settings</li>
|
||||
<li>...</li>
|
||||
</ol>
|
||||
@@ -96,8 +96,8 @@
|
||||
<li>MD5 checksum file of this file</li>
|
||||
<li>${artifactId}-snapshot-version</li>
|
||||
</ul>
|
||||
For exaple for artifact with artifactId = <i>foo</i>
|
||||
the following files will be transfered to the remote repository:
|
||||
For example for artifact with artifactId = <i>foo</i>
|
||||
the following files will be transferred to the remote repository:
|
||||
<ul>
|
||||
<li>foo-20030620.124616.jar</li>
|
||||
<li>foo-20030620.124616.jar.md5</li>
|
||||
@@ -107,11 +107,11 @@
|
||||
</ul>
|
||||
|
||||
File <i>foo-snapshot-version</i>
|
||||
simply contains the version number (20030620.124616)
|
||||
that the snapshot is linked with,
|
||||
contains the version number (20030620.124616)
|
||||
that the snapshot is linked to,
|
||||
so that
|
||||
<a href="http://maven.apache.org/reference/user-guide.html#Resolving%20SNAPSHOT%20Dependencies">'convert-snapshots'</a>
|
||||
can correctly update dependencies in projects which will use this artifact.
|
||||
can correctly update dependencies in projects that will use this artifact.
|
||||
<br/>
|
||||
<b>artifact:deploy-snapshot</b> tag uses the same set of attributes
|
||||
as <a href="artifact:deloy">artifact:deploy</a> tag
|
||||
@@ -128,19 +128,20 @@
|
||||
</ol>
|
||||
</p>
|
||||
<p>
|
||||
<i>Why I should use <b>artifact:install</b> when it is so easy
|
||||
just to copy a file inside my plugin?
|
||||
<i>Why should I use <b>artifact:install</b> when it is so easy
|
||||
to copy a file inside my plugin?
|
||||
</i>
|
||||
<br/>
|
||||
There are few good reason for that:
|
||||
<ul>
|
||||
<li>
|
||||
What is simple now, not necesserly must stay simple in the future.
|
||||
E.g. when Maven will run in client-server mode
|
||||
Although simple now, it will not necessarily remain that way
|
||||
in the future.
|
||||
e.g. When Maven runs in client-server mode
|
||||
information about repository content can be cached
|
||||
and even some files from repository can cached in memory
|
||||
(e.g. POMS). Using centralized "proxy" which copies
|
||||
files to the repository can play importand role in this
|
||||
and some files from the repository can be cached in memory
|
||||
(e.g. POMS). Using a centralized "proxy" which copies
|
||||
files to the repository can play important role in this
|
||||
process.
|
||||
</li>
|
||||
<li>
|
||||
|
||||
Reference in new issue
Block a user