This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-deploy-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 4b934b2 Move the HTTP, FTP and SSH deployment examples to the Maven
guides
4b934b2 is described below
commit 4b934b2aefd95cad3a75785cba5cebc6531987b2
Author: Sylwester Lachiewicz <[email protected]>
AuthorDate: Sat Oct 31 20:10:51 2026 +0000
Move the HTTP, FTP and SSH deployment examples to the Maven guides
---
src/site/markdown/examples/deploy-ftp.md | 76 --------------
src/site/markdown/examples/deploy-http.md | 72 -------------
.../markdown/examples/deploy-network-issues.md | 39 +-------
src/site/markdown/examples/deploy-ssh-external.md | 111 ---------------------
src/site/markdown/index.md.vm | 4 +-
src/site/markdown/project-deployment.md | 4 +-
src/site/site.xml | 4 +-
7 files changed, 4 insertions(+), 306 deletions(-)
diff --git a/src/site/markdown/examples/deploy-ftp.md
b/src/site/markdown/examples/deploy-ftp.md
deleted file mode 100644
index ac578d5..0000000
--- a/src/site/markdown/examples/deploy-ftp.md
+++ /dev/null
@@ -1,76 +0,0 @@
----
-title: Deployment of artifacts with FTP
-author:
- - Jason van Zyl
-date: 2005-10-12
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you 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.
--->
-
-# Deployment of artifacts with FTP
-
-In order to deploy artifacts using FTP you must first specify the use of an
FTP server in the **distributionManagement** element of your POM as well as
specifying an `extension` in your `build` element which will pull in the FTP
artifacts required to deploy with FTP:
-
-```unknown
-<project>
- ...
- <distributionManagement>
- <repository>
- <id>ftp-repository</id>
- <url>ftp://repository.mycompany.com/repository</url>
- </repository>
- </distributionManagement>
-
- <build>
- <extensions>
- <!-- Enabling the use of FTP -->
- <extension>
- <groupId>org.apache.maven.wagon</groupId>
- <artifactId>wagon-ftp</artifactId>
- <version>1.0-beta-6</version>
- </extension>
- </extensions>
- </build>
- ...
-</project>
-```
-
-Your `settings.xml` would contain a `server` element where the `id` of that
element matches `id` of the FTP repository specified in the POM above:
-
-```unknown
-<settings>
- ...
- <servers>
- <server>
- <id>ftp-repository</id>
- <username>user</username>
- <password>pass</password>
- </server>
- </servers>
- ...
-</settings>
-```
-
-You should, of course, make sure that you can login into the specified FTP
server by hand before attempting the deployment with Maven\. Once you have
verified that everything is setup correctly you can now deploy your artifacts
using Maven:
-
-```unknown
-mvn deploy
-```
-
diff --git a/src/site/markdown/examples/deploy-http.md
b/src/site/markdown/examples/deploy-http.md
deleted file mode 100644
index 2289b16..0000000
--- a/src/site/markdown/examples/deploy-http.md
+++ /dev/null
@@ -1,72 +0,0 @@
----
-title: Deployment of artifacts with HTTP(S)
-author:
- - Konrad Windszus
-date: 2025-09-17
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you 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.
--->
-
-# Deployment of artifacts with HTTP(S)
-
-In order to deploy artifacts using HTTP(S) you must specify the use of an
HTTP(S) server in the [**distributionManagement** element of your
POM](https://maven.apache.org/pom.html#Distribution_Management):
-
-```unknown
-<project>
- ...
- <distributionManagement>
- <repository>
- <id>my-mrm-relases</id>
- <url>http://localhost:8081/nexus/content/repositories/release</url>
- </repository>
- </distributionManagement>
- ...
-</project>
-```
-
-## Authentication
-
-Your `settings.xml` would contain a `server` element where the `id` of that
element matches `id` of the HTTP(S) repository specified in the POM above. It
must contain the credentials to be used (in [encrypted
form](https://maven.apache.org/guides/mini/guide-encryption.html)):
-
-```unknown
-<settings>
- ...
- <servers>
- <server>
- <id>my-mrm-releases</id>
- <username><my-encrypted-user></username>
- <password><my-encrypted-password></password>
- </server>
- </servers>
- ...
-</settings>
-```
-
-Further details in [Security and Deployment
Settings](https://maven.apache.org/guides/mini/guide-deployment-security-settings.html).
-
-## HTTP method
-
-Deployment leverages one *HTTP PUT* request per artifact/checksum/metadata
(optionally using HTTP Basic Authentication) with no query parameters. Make
sure your used [Maven repository
manager](https://maven.apache.org/repository-management.html) supports this
method of deployment, otherwise this plugin cannot be used.
-
-*[Sonatype Central
Portal](https://maven.apache.org/repository/guide-central-repository-upload.html)
only supports this via the legacy [Portal OSSRH Staging
API](https://central.sonatype.org/publish/publish-portal-ossrh-staging-api/)
for release versions. [SNAPSHOT
version](https://central.sonatype.org/publish/publish-portal-snapshots/)
deployments for Central Portal are still supported with `maven-deploy-plugin`*.
-
-## HTTP client settings
-
-The HTTP client being used by default depends on the underlying Maven version
as the [Maven Resolver
Transport](https://maven.apache.org/guides/mini/guide-resolver-transport.html)
is leveraged for the actual deployment. One can override that default client
with Maven user property `maven.resolver.transport`. Maven Resolver also
evaluates other advanced [configuration
properties](https://maven.apache.org/resolver-archives/resolver-LATEST-1.x/configuration.html)
which can be set as Maven u [...]
diff --git a/src/site/markdown/examples/deploy-network-issues.md
b/src/site/markdown/examples/deploy-network-issues.md
index 4ce05d0..3d6ad66 100644
--- a/src/site/markdown/examples/deploy-network-issues.md
+++ b/src/site/markdown/examples/deploy-network-issues.md
@@ -78,41 +78,4 @@ Of course, you can configure the repository in your
`pom.xml` if you want to go
### Copying from Local Directory to Target Remote Repository
-`wagon-maven-plugin`'s [`merge-maven-repos`
goal](https://www.mojohaus.org/wagon-maven-plugin/merge-maven-repos-mojo.html)
provides a mechanism to copy from one remote repository to the other, while
merging repository metadata\.
-
-`wagon-maven-plugin`'s [`upload`
goal](https://www.mojohaus.org/wagon-maven-plugin/upload-mojo.html) will do the
same without taking care of repository metadata: use it if you have an empty
repository as target, like a staging repository provided by a repository
manager\.
-
-It can be invoked fully from command line \(renaming `-Dwagon.` with
`wagon.targetId` when [Wagon Maven Plugin 2\.0\.1 will be
released](https://github.com/mojohaus/wagon-maven-plugin/pull/26)\):
-
-```unknown
-mvn org.codehaus.mojo:wagon-maven-plugin:2.0.0:merge-maven-repos \
- -Dwagon.source=file:./target/staging-deploy \
- -Dwagon.target=https://... \
- -Dwagon.=id
-# or once wagon-maven-plugin 2.0.1 is released:
- -Dwagon.targetId=id
-```
-
-or more simply with `mvn wagon:merge-maven-repos` with configuration in
`pom.xml`:
-
-```unknown
-<project>
- [...]
- <build>
- <plugins>
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>wagon-maven-plugin</artifactId>
- <version>2.0.0</version>
- <configuration>
- <source>file:./target/staging-deploy</source>
- <target>${project.distributionManagement.repository.url}</target>
- <targetId>${project.distributionManagement.repository.id}</targetId>
- </configuration>
- </plugin>
- </plugins>
- </build>
- [...]
-</project>
-```
-
+Copying the staged repository to the remote one, retrying as needed, is not a
Deploy Plugin feature. The [Deploying over an unreliable
network](https://maven.apache.org/guides/mini/guide-deployment-transports.html#Deploying_over_an_unreliable_network)
section of the Maven guide shows how to do it with the Wagon Maven Plugin.
diff --git a/src/site/markdown/examples/deploy-ssh-external.md
b/src/site/markdown/examples/deploy-ssh-external.md
deleted file mode 100644
index 8c93459..0000000
--- a/src/site/markdown/examples/deploy-ssh-external.md
+++ /dev/null
@@ -1,111 +0,0 @@
----
-title: Deployment of artifacts in an external SSH command
-author:
- - Jason van Zyl
-date: 2005-10-12
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you 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.
--->
-
-# Deployment of artifacts in an external SSH command
-
-In order to deploy artifacts using SSH you must first specify the use of an
SSH server in the **distributionManagement** element of your POM as well as
specifying an `extension` in your `build` element which will pull in the SSH
artifacts required to deploy with SSH:
-
-```unknown
-
-<project>
- ...
- <distributionManagement>
- <repository>
- <id>ssh-repository</id>
- <url>scpexe://repository.mycompany.com/repository</url>
- </repository>
- </distributionManagement>
-
- <build>
- <extensions>
- <!-- Enabling the use of SSH -->
- <extension>
- <groupId>org.apache.maven.wagon</groupId>
- <artifactId>wagon-ssh-external</artifactId>
- <version>1.0-beta-6</version>
- </extension>
- </extensions>
- </build>
- ..
-</project>
-```
-
-If you are deploying from Unix or have Cygwin installed you won't need to
any additional configuration in your `settings.xml` file as everything will be
taken from the environment\. But if you are on Windows and are using something
like `plink` then you will need something like the following:
-
-```unknown
-
-<settings>
- ...
- <servers>
- <server>
- <id>ssh-repository</id>
- <username>your username in the remote system if different from
local</username>
- <privateKey>/path/to/your/private/key</privateKey> <!-- not needed if
using pageant -->
- <configuration>
- <sshExecutable>plink</sshExecutable>
- <scpExecutable>pscp</scpExecutable>
- <sshArgs>other arguments you may need</sshArgs>
- </configuration>
- </server>
- </servers>
- ...
-</settings>
-```
-
-You should, of course, make sure that you can login into the specified SSH
server by hand before attempting the deployment with Maven\. Once you have
verified that everything is setup correctly you can now deploy your artifacts
using Maven:
-
-```unknown
-mvn deploy
-```
-
-Sometimes you may have permissions problems deploying and if so you can set
the file and directory permissions like so:
-
-```unknown
-
- <settings>
- ...
- <servers>
- <server>
- <id>ssh-repository</id>
- <!--
- |
- | Change default file/dir permissions
- |
- -->
- <filePermissions>664</filePermissions>
- <directoryPermissions>775</directoryPermissions>
- <configuration>
- <sshExecutable>plink</sshExecutable>
- <scpExecutable>pscp</scpExecutable>
- </configuration>
- </server>
- </servers>
- ...
- </settings>
-```
-
-**NOTE:** If you are using Putty it will expect the private key to be in the
`PPK` format and not the standard format so make sure you use `puttygen` to
convert your openssh format key to `PPK` format or generate another one\.
Windows users can find the Putty tools on the [PuTTY Download
Page](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html)\.
-
diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm
index b3cc1ec..6a23d06 100644
--- a/src/site/markdown/index.md.vm
+++ b/src/site/markdown/index.md.vm
@@ -60,9 +60,7 @@ To provide you with better understanding on some usages of
the deploy plugin, yo
_Project Deployment:_
-- [Deployment with HTTP(S)](./examples/deploy-http.html)
-- [Deployment with FTP](./examples/deploy-ftp.html)
-- [Deployment with external SSH](./examples/deploy-ssh-external.html)
+- [Deploying over HTTP(S), FTP and
SSH](https://maven.apache.org/guides/mini/guide-deployment-transports.html)
(Maven guide)
- [Workarounds when there are network
issues](./examples/deploy-network-issues.html)
_File Deployment:_
diff --git a/src/site/markdown/project-deployment.md
b/src/site/markdown/project-deployment.md
index 0581e39..adc3e06 100644
--- a/src/site/markdown/project-deployment.md
+++ b/src/site/markdown/project-deployment.md
@@ -28,7 +28,5 @@ under the License.
Here are examples of using the deploy plugin for project deployment:
-- [Deployment with HTTP(S)](./examples/deploy-http.html)
-- [Deployment with FTP](./examples/deploy-ftp.html)
-- [Deployment with external SSH](./examples/deploy-ssh-external.html)
+- [Deploying over HTTP(S), FTP and
SSH](https://maven.apache.org/guides/mini/guide-deployment-transports.html)
(Maven guide)
- [Workarounds when there are network
issues](./examples/deploy-network-issues.html)
diff --git a/src/site/site.xml b/src/site/site.xml
index 6cde213..e030054 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -41,9 +41,7 @@ under the License.
</menu>
<menu name="Examples">
<item name="Project Deployment" collapse="true"
href="project-deployment.html">
- <item name="Deployment with HTTP(S)" href="examples/deploy-http.html"
/>
- <item name="Deployment with FTP" href="examples/deploy-ftp.html" />
- <item name="Deployment with external SSH"
href="examples/deploy-ssh-external.html"/>
+ <item name="Deploying over HTTP(S), FTP and SSH"
href="https://maven.apache.org/guides/mini/guide-deployment-transports.html"/>
<item name="Deploying With Network Issues"
href="examples/deploy-network-issues.html"/>
</item>