Skip to content

Commit 34eb16c

Browse files
committed
Convert APT to Markdown
1 parent 9454186 commit 34eb16c

19 files changed

+574
-775
lines changed
Lines changed: 33 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,32 @@
1-
------
2-
Deployment of artifacts with FTP
3-
------
4-
Jason van Zyl
5-
------
6-
2005-10-12
7-
------
1+
---
2+
title: Deployment of artifacts with FTP
3+
author:
4+
- Jason van Zyl
5+
date: 2005-10-12
6+
---
87

9-
~~ Licensed to the Apache Software Foundation (ASF) under one
10-
~~ or more contributor license agreements. See the NOTICE file
11-
~~ distributed with this work for additional information
12-
~~ regarding copyright ownership. The ASF licenses this file
13-
~~ to you under the Apache License, Version 2.0 (the
14-
~~ "License"); you may not use this file except in compliance
15-
~~ with the License. You may obtain a copy of the License at
16-
~~
17-
~~ http://www.apache.org/licenses/LICENSE-2.0
18-
~~
19-
~~ Unless required by applicable law or agreed to in writing,
20-
~~ software distributed under the License is distributed on an
21-
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
22-
~~ KIND, either express or implied. See the License for the
23-
~~ specific language governing permissions and limitations
24-
~~ under the License.
8+
<!-- Licensed to the Apache Software Foundation (ASF) under one-->
9+
<!-- or more contributor license agreements. See the NOTICE file-->
10+
<!-- distributed with this work for additional information-->
11+
<!-- regarding copyright ownership. The ASF licenses this file-->
12+
<!-- to you under the Apache License, Version 2.0 (the-->
13+
<!-- "License"); you may not use this file except in compliance-->
14+
<!-- with the License. You may obtain a copy of the License at-->
15+
<!---->
16+
<!-- http://www.apache.org/licenses/LICENSE-2.0-->
17+
<!---->
18+
<!-- Unless required by applicable law or agreed to in writing,-->
19+
<!-- software distributed under the License is distributed on an-->
20+
<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
21+
<!-- KIND, either express or implied. See the License for the-->
22+
<!-- specific language governing permissions and limitations-->
23+
<!-- under the License.-->
2524

26-
~~ NOTE: For help with the syntax of this file, see:
27-
~~ http://maven.apache.org/doxia/references/apt-format.html
25+
# Deployment of artifacts with FTP
2826

29-
Deployment of artifacts with FTP
27+
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:
3028

31-
In order to deploy artifacts using FTP you must first specify the use of an FTP server in the
32-
<<distributionManagement>> element of your POM as well as specifying an <<<extension>>> in your
33-
<<<build>>> element which will pull in the FTP artifacts required to deploy with FTP:
34-
35-
+----+
29+
```unknown
3630
<project>
3731
...
3832
<distributionManagement>
@@ -54,12 +48,11 @@ Deployment of artifacts with FTP
5448
</build>
5549
...
5650
</project>
57-
+----+
51+
```
5852

59-
Your <<<settings.xml>>> would contain a <<<server>>> element where the <<<id>>> of that element matches <<<id>>> of the
60-
FTP repository specified in the POM above:
53+
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:
6154

62-
+----+
55+
```unknown
6356
<settings>
6457
...
6558
<servers>
@@ -71,12 +64,11 @@ Deployment of artifacts with FTP
7164
</servers>
7265
...
7366
</settings>
74-
+----+
67+
```
7568

76-
You should, of course, make sure that you can login into the specified FTP server by hand before attempting the
77-
deployment with Maven. Once you have verified that everything is setup correctly you can now deploy your artifacts
78-
using Maven:
69+
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:
7970

80-
+----+
71+
```unknown
8172
mvn deploy
82-
+----+
73+
```
74+
Lines changed: 64 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,38 @@
1-
------
2-
Deploying With Network Issues
3-
------
4-
Hervé Boutemy
5-
------
6-
2019-01-20
7-
------
8-
9-
~~ Licensed to the Apache Software Foundation (ASF) under one
10-
~~ or more contributor license agreements. See the NOTICE file
11-
~~ distributed with this work for additional information
12-
~~ regarding copyright ownership. The ASF licenses this file
13-
~~ to you under the Apache License, Version 2.0 (the
14-
~~ "License"); you may not use this file except in compliance
15-
~~ with the License. You may obtain a copy of the License at
16-
~~
17-
~~ http://www.apache.org/licenses/LICENSE-2.0
18-
~~
19-
~~ Unless required by applicable law or agreed to in writing,
20-
~~ software distributed under the License is distributed on an
21-
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
22-
~~ KIND, either express or implied. See the License for the
23-
~~ specific language governing permissions and limitations
24-
~~ under the License.
25-
26-
~~ NOTE: For help with the syntax of this file, see:
27-
~~ http://maven.apache.org/doxia/references/apt-format.html
28-
29-
Deploying With Network Issues
30-
31-
Sometimes, network quality from building machine to the remote repository is not perfect.
32-
Of course, improving the network would be the best solution, but it is not always possible.
33-
34-
There are a few strategies to work around the network issue.
35-
36-
* Configuring Multiple Tries
37-
38-
Deploy plugin provides {{{../deploy-mojo.html#retryFailedDeploymentCount}<<<retryFailedDeploymentCount>>> parameter}}
39-
to retry deployment multiple times before giving up and returning a failure for the <<<deploy>>> goal:
40-
41-
+----+
1+
---
2+
title: Deploying With Network Issues
3+
author:
4+
- Hervé Boutemy
5+
date: 2019-01-20
6+
---
7+
8+
<!-- Licensed to the Apache Software Foundation (ASF) under one-->
9+
<!-- or more contributor license agreements. See the NOTICE file-->
10+
<!-- distributed with this work for additional information-->
11+
<!-- regarding copyright ownership. The ASF licenses this file-->
12+
<!-- to you under the Apache License, Version 2.0 (the-->
13+
<!-- "License"); you may not use this file except in compliance-->
14+
<!-- with the License. You may obtain a copy of the License at-->
15+
<!---->
16+
<!-- http://www.apache.org/licenses/LICENSE-2.0-->
17+
<!---->
18+
<!-- Unless required by applicable law or agreed to in writing,-->
19+
<!-- software distributed under the License is distributed on an-->
20+
<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
21+
<!-- KIND, either express or implied. See the License for the-->
22+
<!-- specific language governing permissions and limitations-->
23+
<!-- under the License.-->
24+
25+
# Deploying With Network Issues
26+
27+
Sometimes, network quality from building machine to the remote repository is not perfect\. Of course, improving the network would be the best solution, but it is not always possible\.
28+
29+
There are a few strategies to work around the network issue\.
30+
31+
## Configuring Multiple Tries
32+
33+
Deploy plugin provides [`retryFailedDeploymentCount` parameter](../deploy-mojo.html#retryFailedDeploymentCount) to retry deployment multiple times before giving up and returning a failure for the `deploy` goal:
34+
35+
```unknown
4236
<project>
4337
[...]
4438
<build>
@@ -54,60 +48,52 @@ Deploying With Network Issues
5448
</build>
5549
[...]
5650
</project>
57-
+----+
51+
```
5852

59-
* Deploying to a Local Staging Directory
53+
## Deploying to a Local Staging Directory
6054

61-
When the network is really not consistent, a deeper strategy is to deploy in 2 steps:
55+
When the network is really not consistent, a deeper strategy is to deploy in 2 steps:
6256

63-
1. <<<deploy>>> to a local directory during the build, for example <<<file:./target/staging-deploy>>>,
57+
1\. `deploy` to a local directory during the build, for example `file:./target/staging-deploy`,
6458

65-
2. then copy from the local area to the target remote repository, retrying as much as necessary.
59+
2\. then copy from the local area to the target remote repository, retrying as much as necessary\.
6660

67-
[]
61+
### Deploying to a Local Directory
6862

69-
** Deploying to a Local Directory
63+
Deploying to a local directory can be done from command line, without changing POM, using [`altDeploymentRepository` parameter](../deploy-mojo.html#altDeploymentRepository):
7064

71-
Deploying to a local directory can be done from command line, without changing POM, using
72-
{{{../deploy-mojo.html#altDeploymentRepository}<<<altDeploymentRepository>>> parameter}}:
73-
74-
+----+
65+
```unknown
7566
mvn deploy -DaltDeploymentRepository=local::file:./target/staging-deploy
76-
+----+
67+
```
7768

78-
or for older 2.x version of maven-deploy-plugin
69+
or for older 2\.x version of maven\-deploy\-plugin
7970

80-
+----+
71+
```unknown
8172
mvn deploy -DaltDeploymentRepository=local::default::file:./target/staging-deploy
82-
+----+
83-
84-
Of course, you can configure the repository in your <<<pom.xml>>> if you want to go from a temporary strategy
85-
to the general strategy.
86-
87-
** Copying from Local Directory to Target Remote Repository
88-
89-
<<<wagon-maven-plugin>>>'s {{{https://www.mojohaus.org/wagon-maven-plugin/merge-maven-repos-mojo.html}<<<merge-maven-repos>>> goal}}
90-
provides a mechanism to copy from one remote repository to the other, while merging repository metadata.
91-
92-
<<<wagon-maven-plugin>>>'s {{{https://www.mojohaus.org/wagon-maven-plugin/upload-mojo.html}<<<upload>>> goal}}
93-
will do the same without taking care of repository metadata: use it if you have an empty repository as target,
94-
like a staging repository provided by a repository manager.
95-
96-
It can be invoked fully from command line (renaming <<<-Dwagon.>>> with <<<wagon.targetId>>> when
97-
{{{https://github.com/mojohaus/wagon-maven-plugin/pull/26}Wagon Maven Plugin 2.0.1 will be released}}):
98-
99-
+----+
73+
```
74+
75+
Of course, you can configure the repository in your `pom.xml` if you want to go from a temporary strategy to the general strategy\.
76+
77+
### Copying from Local Directory to Target Remote Repository
78+
79+
`wagon-maven-plugin`&apos;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\.
80+
81+
`wagon-maven-plugin`&apos;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\.
82+
83+
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)\):
84+
85+
```unknown
10086
mvn org.codehaus.mojo:wagon-maven-plugin:2.0.0:merge-maven-repos \
10187
-Dwagon.source=file:./target/staging-deploy \
10288
-Dwagon.target=https://... \
10389
-Dwagon.=id
10490
# or once wagon-maven-plugin 2.0.1 is released:
10591
-Dwagon.targetId=id
106-
+----+
92+
```
10793

108-
or more simply with <<<mvn wagon:merge-maven-repos>>> with configuration in <<<pom.xml>>>:
94+
or more simply with `mvn wagon:merge-maven-repos` with configuration in `pom.xml`:
10995

110-
+----+
96+
```unknown
11197
<project>
11298
[...]
11399
<build>
@@ -126,4 +112,5 @@ mvn org.codehaus.mojo:wagon-maven-plugin:2.0.0:merge-maven-repos \
126112
</build>
127113
[...]
128114
</project>
129-
+----+
115+
```
116+
Lines changed: 40 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,32 @@
1-
------
2-
Deployment of artifacts in an external SSH command
3-
------
4-
Jason van Zyl
5-
------
6-
2005-10-12
7-
------
8-
9-
~~ Licensed to the Apache Software Foundation (ASF) under one
10-
~~ or more contributor license agreements. See the NOTICE file
11-
~~ distributed with this work for additional information
12-
~~ regarding copyright ownership. The ASF licenses this file
13-
~~ to you under the Apache License, Version 2.0 (the
14-
~~ "License"); you may not use this file except in compliance
15-
~~ with the License. You may obtain a copy of the License at
16-
~~
17-
~~ http://www.apache.org/licenses/LICENSE-2.0
18-
~~
19-
~~ Unless required by applicable law or agreed to in writing,
20-
~~ software distributed under the License is distributed on an
21-
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
22-
~~ KIND, either express or implied. See the License for the
23-
~~ specific language governing permissions and limitations
24-
~~ under the License.
25-
26-
~~ NOTE: For help with the syntax of this file, see:
27-
~~ http://maven.apache.org/doxia/references/apt-format.html
28-
29-
Deployment of artifacts in an external SSH command
30-
31-
In order to deploy artifacts using SSH you must first specify the use of an SSH server in the
32-
<<distributionManagement>> element of your POM as well as specifying an <<<extension>>> in your
33-
<<<build>>> element which will pull in the SSH artifacts required to deploy with SSH:
34-
35-
+----+
1+
---
2+
title: Deployment of artifacts in an external SSH command
3+
author:
4+
- Jason van Zyl
5+
date: 2005-10-12
6+
---
7+
8+
<!-- Licensed to the Apache Software Foundation (ASF) under one-->
9+
<!-- or more contributor license agreements. See the NOTICE file-->
10+
<!-- distributed with this work for additional information-->
11+
<!-- regarding copyright ownership. The ASF licenses this file-->
12+
<!-- to you under the Apache License, Version 2.0 (the-->
13+
<!-- "License"); you may not use this file except in compliance-->
14+
<!-- with the License. You may obtain a copy of the License at-->
15+
<!---->
16+
<!-- http://www.apache.org/licenses/LICENSE-2.0-->
17+
<!---->
18+
<!-- Unless required by applicable law or agreed to in writing,-->
19+
<!-- software distributed under the License is distributed on an-->
20+
<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
21+
<!-- KIND, either express or implied. See the License for the-->
22+
<!-- specific language governing permissions and limitations-->
23+
<!-- under the License.-->
24+
25+
# Deployment of artifacts in an external SSH command
26+
27+
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:
28+
29+
```unknown
3630
3731
<project>
3832
...
@@ -55,14 +49,11 @@ Deployment of artifacts in an external SSH command
5549
</build>
5650
..
5751
</project>
52+
```
5853

59-
+----+
54+
If you are deploying from Unix or have Cygwin installed you won&apos;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:
6055

61-
If you are deploying from Unix or have Cygwin installed you won't need to any additional configuration in your <<<settings.xml>>>
62-
file as everything will be taken from the environment. But if you are on Windows and are using something like <<<plink>>> then
63-
you will need something like the following:
64-
65-
+----+
56+
```unknown
6657
6758
<settings>
6859
...
@@ -80,21 +71,17 @@ Deployment of artifacts in an external SSH command
8071
</servers>
8172
...
8273
</settings>
74+
```
8375

84-
+----+
85-
86-
You should, of course, make sure that you can login into the specified SSH server by hand before attempting the
87-
deployment with Maven. Once you have verified that everything is setup correctly you can now deploy your artifacts
88-
using Maven:
76+
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:
8977

90-
+----+
78+
```unknown
9179
mvn deploy
92-
+----+
80+
```
9381

94-
Sometimes you may have permissions problems deploying and if so you can set the file and directory permissions
95-
like so:
82+
Sometimes you may have permissions problems deploying and if so you can set the file and directory permissions like so:
9683

97-
+----+
84+
```unknown
9885
9986
<settings>
10087
...
@@ -116,10 +103,7 @@ mvn deploy
116103
</servers>
117104
...
118105
</settings>
106+
```
119107

120-
+----+
108+
**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)\.
121109

122-
<<NOTE:>> If you are using Putty it will expect the private key to be in the <<<PPK>>> format and not the standard
123-
format so make sure you use <<<puttygen>>> to convert your openssh format key to <<<PPK>>> format or generate another
124-
one. Windows users can find the Putty tools on the
125-
{{{https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html}PuTTY Download Page}}.

0 commit comments

Comments
 (0)