Modified: maven/website/content/guides/mini/guide-3rd-party-jars-local.html ============================================================================== --- maven/website/content/guides/mini/guide-3rd-party-jars-local.html (original) +++ maven/website/content/guides/mini/guide-3rd-party-jars-local.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/mini/guide-3rd-party-jars-local.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/mini/guide-3rd-party-jars-local.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -10,7 +10,8 @@ <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M4" /> - <meta name="author" content="Jason van Zyl, Robert Scholte" /> + <meta name="author" content="Jason van Zyl +Robert Scholte" /> <meta name="date" content="2013-07-13" /> <title>Maven – Guide to installing 3rd party JARs</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.11.1.min.css" /> @@ -48,7 +49,7 @@ <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="active ">Guide to installing 3rd party JARs <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/mini/guide-3rd-party-jars-local.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to installing 3rd party JARs <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/mini/guide-3rd-party-jars-local.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -152,40 +153,19 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Guide to installing 3rd party JARs</h2> -<p>Occasionally, you will have 3rd party JARs that you need to put in your local repository for use in your builds, since they don't exist in any public repository like <a href="https://search.maven.org"; class="externalLink">Maven Central</a>. The JARs must be placed in the local repository in the correct place in order for it to be correctly picked up by Apache Maven.</p> -<p>To make this easier, and less error prone, we have provided an <code>install-file</code> goal in the <a href="/plugins/maven-install-plugin/">maven-install-plugin</a> which should make this relatively painless.</p> +<section> +<h1>Guide to installing 3rd party JARs</h1> +<p>Occasionally, you will have 3rd party JARs that you need to put in your local repository for use in your builds, since they don't exist in any public repository like <a class="externalLink" href="https://search.maven.org";>Maven Central</a>. The JARs must be placed in the local repository in the correct place in order for it to be correctly picked up by Apache Maven.</p> +<p>To make this easier, and less error prone, we have provided an <code>install-file</code> goal in the <a href="/plugins/maven-install-plugin/">maven-install-plugin</a> which should make this relatively painless. </p> <p>To install a JAR in the local repository use the following command:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn install:install-file -Dfile=<path-to-file> -DgroupId=<group-id> -DartifactId=<artifact-id> -Dversion=<version> -Dpackaging=<packaging> -</code></pre></div> +<div> +<pre>mvn install:install-file -Dfile=<path-to-file> -DgroupId=<group-id> -DartifactId=<artifact-id> -Dversion=<version> -Dpackaging=<packaging></pre></div> <p>If there's a pom-file as well, you can install it with the following command:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn install:install-file -Dfile=<path-to-file> -DpomFile=<path-to-pomfile> -</code></pre></div> -<p>With version 2.5 of the maven-install-plugin, it can get even simpler: if the JAR was built by Apache Maven, it'll contain a pom.xml in a subdirectory of the META-INF/ directory, which will be read by default. In that case, all you need to do is:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile=<path-to-file> -</code></pre></div></section></section> +<div> +<pre>mvn install:install-file -Dfile=<path-to-file> -DpomFile=<path-to-pomfile></pre></div> +<p>With version 2.5 of the maven-install-plugin, it can get even simpler: if the JAR was built by Apache Maven, it'll contain a pom.xml in a subfolder of the META-INF/ directory, which will be read by default. In that case, all you need to do is:</p> +<div> +<pre>mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile=<path-to-file></pre></div></section> </main> </div> </div>
Modified: maven/website/content/guides/mini/guide-3rd-party-jars-remote.html ============================================================================== --- maven/website/content/guides/mini/guide-3rd-party-jars-remote.html (original) +++ maven/website/content/guides/mini/guide-3rd-party-jars-remote.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/mini/guide-3rd-party-jars-remote.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/mini/guide-3rd-party-jars-remote.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <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="active ">Guide to deploying 3rd party JARs to remote repository <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/mini/guide-3rd-party-jars-remote.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to deploying 3rd party JARs to remote repository <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/mini/guide-3rd-party-jars-remote.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -152,57 +152,34 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Guide to deploying 3rd party JARs to remote repository</h2> +<section> +<h1>Guide to deploying 3rd party JARs to remote repository</h1> <p>Same concept of the <a href="./guide-3rd-party-jars-local.html">install:install-file</a> goal of the maven-install-plugin where the 3rd party JAR is installed in the local repository. But this time instead to local repository the JAR will be install both in the local and remote repository.</p> <p>To deploy a 3rd party JAR use the deploy:deploy-file goal under maven-deploy-plugin.</p> <p>First, the wagon-provider(wagon-ftp, wagon-file, etc..) must be placed to your <code>${maven.home}/lib</code>.</p> <p>Then execute the command:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn deploy:deploy-file -DgroupId=<group-id> \ +<div> +<pre>mvn deploy:deploy-file -DgroupId=<group-id> \ -DartifactId=<artifact-id> \ -Dversion=<version> \ -Dpackaging=<type-of-packaging> \ -Dfile=<path-to-file> \ -DrepositoryId=<id-to-map-on-server-section-of-settings.xml> \ - -Durl=<url-of-the-repository-to-deploy> -</code></pre></div><section> -<h3>Deploying a 3rd party JAR with a generic POM</h3> + -Durl=<url-of-the-repository-to-deploy></pre></div><section> +<h2>Deploying a 3rd party JAR with a generic POM</h2> <p>By default, deploy:deploy-file generates a generic POM(.pom) to be deploy together with the 3rd party JAR. To disable this feature we should set the <code>generatePOM</code> argument to false.</p> - -<div class="source"><pre class="prettyprint linenums"><code>-DgeneratePom=false -</code></pre></div></section><section> -<h3>Deploying a 3rd party JAR with a customized POM</h3> +<div> +<pre>-DgeneratePom=false</pre></div></section><section> +<h2>Deploying a 3rd party JAR with a customized POM</h2> <p>If a POM is already existing for the 3rd Party JAR and you want to deploy it together with the JAR we should use the <code>pomFile</code> argument of the deploy-file goal. See sample below.</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn deploy:deploy-file -DpomFile=<path-to-pom> \ +<div> +<pre>mvn deploy:deploy-file -DpomFile=<path-to-pom> \ -Dfile=<path-to-file> \ -DrepositoryId=<id-to-map-on-server-section-of-settings.xml> \ - -Durl=<url-of-the-repository-to-deploy> -</code></pre></div> + -Durl=<url-of-the-repository-to-deploy></pre></div> <p>Note that <code>groupId</code>, <code>artifactId</code>, <code>version</code> and <code>packaging</code> arguments are not included here because deploy-file goal will get these information from the given POM.</p></section><section> -<h3>Deploying Source Jars</h3><!-- TODO: Check the following, cause i don't this is true anymore. I assume packaging should be jar --> -<!-- Â and the classifier should be set to source. --> - -<p>To deploy a 3rd party source jar, packaging should be set to <code>java-source</code>, and generatePom should be set to <code>false</code>.</p></section></section></section> +<h2>Deploying Source Jars</h2> +<p>To deploy a 3rd party source jar, packaging should be set to <code>java-source</code>, and generatePom should be set to <code>false</code>.</p></section></section> </main> </div> </div> Modified: maven/website/content/guides/mini/guide-archive-configuration.html ============================================================================== --- maven/website/content/guides/mini/guide-archive-configuration.html (original) +++ maven/website/content/guides/mini/guide-archive-configuration.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/mini/guide-archive-configuration.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/mini/guide-archive-configuration.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <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="active ">Guide to Configuring Archive Plugins <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/mini/guide-archive-configuration.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to Configuring Archive Plugins <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/mini/guide-archive-configuration.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -154,32 +154,13 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Guide to Configuring Archive Plugins</h2> +<section> +<h1>Guide to Configuring Archive Plugins</h1> <p>Many Java archive generating plugins accept the <code>archive</code> configuration element to customize the generation of the archive. In the standard Maven Plugins, this includes the <code>jar</code>, <code>war</code>, <code>ejb</code>, <code>ear</code> and <code>assembly</code> plugins.</p><section> -<h3>Disabling Maven Meta Information</h3> +<h2>Disabling Maven Meta Information</h2> <p>By default, Maven generated archives include the <code>META-INF/maven</code> directory, which contains the <code>pom.xml</code> file used to build the archive, and a <code>pom.properties</code> file that includes some basic properties in a small, easier to read format.</p> <p>To disable the generation of these files, include the following configuration for your plugin (in this example, the WAR plugin is used):</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +<div class="source"><pre class="prettyprint linenums"><project> ... <build> <plugins> @@ -197,11 +178,9 @@ under the License. </build> ... </project> - -</code></pre></div><!-- other things: index, compress --> -</section><section> -<h3>Configuring the Manifest</h3> -<p>The archive configuration also accepts manifest configuration. See <a href="./guide-manifest.html">Guide to Working with Manifests</a> for more information.</p></section></section></section> +</pre></div></section><section> +<h2>Configuring the Manifest</h2> +<p>The archive configuration also accepts manifest configuration. See <a href="./guide-manifest.html">Guide to Working with Manifests</a> for more information.</p></section></section> </main> </div> </div> Modified: maven/website/content/guides/mini/guide-assemblies.html ============================================================================== --- maven/website/content/guides/mini/guide-assemblies.html (original) +++ maven/website/content/guides/mini/guide-assemblies.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/mini/guide-assemblies.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/mini/guide-assemblies.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <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="active ">Guide to Creating Assemblies <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/mini/guide-assemblies.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to Creating Assemblies <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/mini/guide-assemblies.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -154,29 +154,10 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Guide to creating assemblies</h2> +<section> +<h1>Guide to creating assemblies</h1> <p>The assembly mechanism in Maven provides an easy way to create distributions using a assembly descriptor and dependency information found in you POM. In order to use the assembly plug-in you need to configure the assembly plug-in in your POM and it might look like the following:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +<div class="source"><pre class="prettyprint linenums"><project> <parent> <artifactId>maven</artifactId> <groupId>org.apache.maven</groupId> @@ -210,13 +191,11 @@ under the License. </plugins> </build> ... -</project> -</code></pre></div> +</project></pre></div> <p>You'll notice that the assembly descriptor is located in <code>${project.basedir}/src/assembly</code> which is the <a href="../introduction/introduction-to-the-standard-directory-layout.html">standard</a> location for assembly descriptors.</p><section> -<h3>Creating a binary assembly</h3> +<h2>Creating a binary assembly</h2> <p>This is the most typical usage of the assembly plugin where you are creating a distribution for standard use.</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" +<div class="source"><pre class="prettyprint linenums"><assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd"> <id>bin</id> <formats> @@ -246,12 +225,10 @@ under the License. <outputDirectory>docs</outputDirectory> </fileSet> </fileSets> -</assembly> -</code></pre></div> +</assembly></pre></div> <p>You can use a manually defined assembly descriptor as mentioned before but it is simpler to use the <a href="/plugins/maven-assembly-plugin/descriptor-refs.html#bin">pre-defined assembly descriptor bin</a> in such cases.</p> -<p>How to use such pre-defined assembly descriptors is described in the <a href="/plugins/maven-assembly-plugin/usage.html#configuration">documentation of maven-assembly-plugin</a>.</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><assembly +<p>How to use such pre-defined assembly descriptors is described in the <a href="/plugins/maven-assembly-plugin/usage.html#Configuration">documentation of maven-assembly-plugin</a>.</p> +<div class="source"><pre class="prettyprint linenums"><assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd"> @@ -285,11 +262,9 @@ under the License. </dependencySet> </dependencySets> </assembly> - -</code></pre></div> +</pre></div> <p>If you like to create a source distribution package the best solution is to use the <a href="/plugins/maven-assembly-plugin/descriptor-refs.html#src">pre-defined assembly descriptor src</a> for such purposes.</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" +<div class="source"><pre class="prettyprint linenums"><assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd"> <id>src</id> <formats> @@ -313,12 +288,10 @@ under the License. <useDefaultExcludes>true</useDefaultExcludes> </fileSet> </fileSets> -</assembly> -</code></pre></div> +</assembly></pre></div> <p>You can now create the defined distribution packages via command line like this:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn package -</code></pre></div></section></section></section> +<div> +<pre>mvn package</pre></div></section></section> </main> </div> </div> Modified: maven/website/content/guides/mini/guide-attached-tests.html ============================================================================== --- maven/website/content/guides/mini/guide-attached-tests.html (original) +++ maven/website/content/guides/mini/guide-attached-tests.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/mini/guide-attached-tests.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/mini/guide-attached-tests.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <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="active ">Guide to using attached tests <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/mini/guide-attached-tests.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to using attached tests <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/mini/guide-attached-tests.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -123,29 +123,10 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Guide to using attached tests</h2> +<section> +<h1>Guide to using attached tests</h1> <p>You can reuse the tests that you have created for one project in another. For example, suppose <code>foo-core</code> contains test code in the <code>${basedir}/src/test/java</code>. To package up those compiled tests in a JAR and deploy them for general reuse, configure the <code>maven-jar-plugin</code> as follows:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> <build> <plugins> @@ -164,12 +145,10 @@ under the License. </plugins> </build> </project> - -</code></pre></div> +</pre></div> <p>The attached test JAR can be installed and deployed like any other Maven artifact.</p> <p>To use the attached test JAR, specify a dependency on the main artifact with a specified type of <code>test-jar</code> and the <code>classifier</code>.</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> ... <dependencies> @@ -212,8 +191,7 @@ under the License. </build> ... </project> - -</code></pre></div></section></section> +</pre></div></section> </main> </div> </div> Modified: maven/website/content/guides/mini/guide-bash-m2-completion.html ============================================================================== --- maven/website/content/guides/mini/guide-bash-m2-completion.html (original) +++ maven/website/content/guides/mini/guide-bash-m2-completion.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/mini/guide-bash-m2-completion.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/mini/guide-bash-m2-completion.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -10,7 +10,9 @@ <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M4" /> - <meta name="author" content="Trygve Laugstol, Jason van Zyl, Karl Heinz Marbaise" /> + <meta name="author" content="Trygve Laugstol +Jason van Zyl +Karl Heinz Marbaise" /> <meta name="date" content="2016-01-24" /> <title>Maven – Guide to Maven auto completion using BASH</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.11.1.min.css" /> @@ -48,7 +50,7 @@ <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="active ">Guide to Maven auto completion using BASH <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/mini/guide-bash-m2-completion.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to Maven auto completion using BASH <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/mini/guide-bash-m2-completion.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -123,27 +125,9 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Guide to Maven auto completion using BASH</h2> -<p>If you like having bash completion which i can recommend if you are working with Maven on command line i would suggest to install the following <a href="https://github.com/juven/maven-bash-completion"; class="externalLink">Maven Bash Auto Completion</a> to fullfil you needs.</p></section></section> +<section> +<h1>Guide to Maven auto completion using BASH</h1> +<p>If you like having bash completion which i can recommend if you are working with Maven on command line i would suggest to install the following <a class="externalLink" href="https://github.com/juven/maven-bash-completion";>Maven Bash Auto Completion</a> to fullfil you needs.</p></section> </main> </div> </div> Modified: maven/website/content/guides/mini/guide-building-for-different-environments.html ============================================================================== --- maven/website/content/guides/mini/guide-building-for-different-environments.html (original) +++ maven/website/content/guides/mini/guide-building-for-different-environments.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/mini/guide-building-for-different-environments.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/mini/guide-building-for-different-environments.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <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="active ">Building For Different Environments <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/mini/guide-building-for-different-environments.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Building For Different Environments <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/mini/guide-building-for-different-environments.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -154,58 +154,29 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Building For Different Environments</h2> +<section> +<h1>Building For Different Environments</h1> <p>Building the same artifact for different environments has always been an annoyance. You have multiple environments, for instance test and production servers or, maybe a set of servers that run the same application with different configurations. In this guide I'll explain how you can use profiles to build and package artifacts configured for specific environments. See <a href="../introduction/introduction-to-profiles.html">Introduction to Build Profiles</a> for a more in-depth explanation of the profile concept.</p> <p>Note:</p> <ul> - -<li> -<p>This guide assume that you have basic Maven knowledge.</p></li> -<li> -<p>It will show a way to configure Maven to solve simple configuration set-ups only. By simple configuration set-up I mean cases where you only have a single file or a small set of files that vary for each environment. There are other and better ways to handle two and many-dimensional configuration issues.</p> -<p>This example assume the use of the <a href="../introduction/introduction-to-the-standard-directory-layout.html">Standard Directory Layout</a>.</p></li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code>pom.xml +<li>This guide assume that you have basic Maven knowledge.</li> +<li>It will show a way to configure Maven to solve simple configuration set-ups only. By simple configuration set-up I mean cases where you only have a single file or a small set of files that vary for each environment. There are other and better ways to handle two and many-dimensional configuration issues. +<p>This example assume the use of the <a href="../introduction/introduction-to-the-standard-directory-layout.html">Standard Directory Layout</a>.</p> +<div> +<pre>pom.xml src/ main/ java/ resources/ test/ - java/ -</code></pre></div> + java/</pre></div></li></ul> <p>Under <code>src/main/resources</code> there are three files:</p> <ul> - -<li> -<p><code>environment.properties</code> - This is the default configuration and will be packaged in the artifact by default.</p></li> -<li> -<p><code>environment.test.properties</code> - This is the variant for the test environment.</p></li> -<li> -<p><code>environment.prod.properties</code> - This is basically the same as the test variant and will be used in the production environment.</p> -<p>In the project descriptor, you need to configure the different profiles. Only the test profile is showed here.</p></li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> <profiles> +<li><code>environment.properties</code> - This is the default configuration and will be packaged in the artifact by default.</li> +<li><code>environment.test.properties</code> - This is the variant for the test environment.</li> +<li><code>environment.prod.properties</code> - This is basically the same as the test variant and will be used in the production environment. +<p>In the project descriptor, you need to configure the different profiles. Only the test profile is showed here.</p> +<div class="source"><pre class="prettyprint linenums"> <profiles> <profile> <id>test</id> <build> @@ -254,30 +225,23 @@ src/ .. Other profiles go here .. - </profiles> -</code></pre></div> + </profiles></pre></div> <p>Three things are configured in this snippet:</p> -<p>1 It configures the antrun plugin to execute the run goal in the test phase where it will copy the <code>environment.test.properties</code> file to <code>environment.properties</code>.</p> -<p>1 It will configure the test plugin to skip all tests when building the test and production artifacts. This is useful as you probably don't want to run tests against the production system</p> -<p>1 It configures the JAR plugin to create an “attached” JAR with the “test” classifier.</p> - -<div class="source"><pre class="prettyprint linenums"><code>To activate this profile execute `mvn -Ptest install` and Maven will execute the steps in the profile in addition to the normal steps. From this build you will get two artifacts, "foo-1.0.jar" and "foo-1.0-test.jar". These two jars will identical. -</code></pre></div></section><section> -<h2>Caveats</h2> +<ol style="list-style-type: decimal"> +<li>It configures the antrun plugin to execute the run goal in the test phase where it will copy the <code>environment.test.properties</code> file to <code>environment.properties</code>.</li> +<li>It will configure the test plugin to skip all tests when building the test and production artifacts. This is useful as you probably don't want to run tests against the production system</li> +<li>It configures the JAR plugin to create an "attached" JAR with the "test" classifier. +<p>To activate this profile execute <code>mvn -Ptest install</code> and Maven will execute the steps in the profile in addition to the normal steps. From this build you will get two artifacts, "foo-1.0.jar" and "foo-1.0-test.jar". These two jars will identical. </p></li></ol></li></ul></section><section> +<h1>Caveats</h1> <ul> - -<li> -<p>Currently Maven doesn't allow a project build to only produce attached artifacts. (i.e. it has to produce a “main” artifact as well) This results in two equal JARs being packaged and installed. The JAR plugin probably should also get improved support for this use case to that two different output directories will be used as the basis for building the JAR.</p></li> -<li> -<p>The usage of the delete task might seem a bit odd but is required to make sure that the copy task actually will copy the file. The copy task will look at the timestamps of the source and destination files, only when copying the files it won't know that the actually source file might be different than the last time it was executed.</p></li> -<li> -<p>After the build the test configuration will be in target/classes and won't be overridden because the resources plugin uses the same timestamp checking, so you should always do a clean after executing Maven with a profile.</p></li> -<li> -<p>For the reasons given above it's imperative that you only build an artifact for a single environment in a single execution at a time and that you execute “mvn clean” whenever you change the profile switches. If not, you might get artifacts with a mixed set of configuration files.</p></li> -</ul></section><section> -<h2>Resources</h2> -<p>1 <a href="../introduction/introduction-to-profiles.html">Introduction to Build Profiles</a></p> -<p>1 <a href="../introduction/introduction-to-the-standard-directory-layout.html">Standard Directory Layout</a></p></section></section> +<li>Currently Maven doesn't allow a project build to only produce attached artifacts. (i.e. it has to produce a "main" artifact as well) This results in two equal JARs being packaged and installed. The JAR plugin probably should also get improved support for this use case to that two different output directories will be used as the basis for building the JAR.</li> +<li>The usage of the delete task might seem a bit odd but is required to make sure that the copy task actually will copy the file. The copy task will look at the timestamps of the source and destination files, only when copying the files it won't know that the actually source file might be different than the last time it was executed.</li> +<li>After the build the test configuration will be in target/classes and won't be overridden because the resources plugin uses the same timestamp checking, so you should always do a clean after executing Maven with a profile.</li> +<li>For the reasons given above it's imperative that you only build an artifact for a single environment in a single execution at a time and that you execute "mvn clean" whenever you change the profile switches. If not, you might get artifacts with a mixed set of configuration files.</li></ul></section><section> +<h1>Resources</h1> +<ol style="list-style-type: decimal"> +<li><a href="../introduction/introduction-to-profiles.html">Introduction to Build Profiles</a></li> +<li><a href="../introduction/introduction-to-the-standard-directory-layout.html">Standard Directory Layout</a></li></ol></section> </main> </div> </div> Modified: maven/website/content/guides/mini/guide-configuring-maven.html ============================================================================== --- maven/website/content/guides/mini/guide-configuring-maven.html (original) +++ maven/website/content/guides/mini/guide-configuring-maven.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/mini/guide-configuring-maven.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/mini/guide-configuring-maven.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <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="active ">Guide to Configuring Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/mini/guide-configuring-maven.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to Configuring Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/mini/guide-configuring-maven.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -154,69 +154,40 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -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. ---> -<section><section> -<h2>Configuring Maven</h2> +<section> +<h1>Configuring Maven</h1> <p>Maven configuration occurs at 3 levels:</p> <ul> - -<li> -<p><em>Project</em> - most static configuration occurs in <code>pom.xml</code></p></li> -<li> -<p><em>Installation</em> - this is configuration added once for a Maven installation</p></li> -<li> -<p><em>User</em> - this is configuration specific to a particular user</p></li> -</ul> +<li><i>Project</i> - most static configuration occurs in <code>pom.xml</code></li> +<li><i>Installation</i> - this is configuration added once for a Maven installation</li> +<li><i>User</i> - this is configuration specific to a particular user</li></ul> <p>The separation is quite clear - the project defines information that applies to the project, no matter who is building it, while the others both define settings for the current environment.</p> -<p><strong>Note:</strong> the installation and user configuration cannot be used to add shared project information - for example, setting <code><organization></code> or <code><distributionManagement></code> company-wide.</p> -<p>For this, you should have your projects inherit from a company-wide parent <code>pom.xml</code>.</p><!-- TODO: versioning doc that discusses this --> - +<p><b>Note:</b> the installation and user configuration cannot be used to add shared project information - for example, setting <code><organization></code> or <code><distributionManagement></code> company-wide.</p> +<p>For this, you should have your projects inherit from a company-wide parent <code>pom.xml</code>.</p> <p>You can specify your user configuration in <code>${user.home}/.m2/settings.xml</code>. A <a href="../../maven-settings/settings.html">full reference</a> to the configuration file is available. This section will show how to make some common configurations. Note that the file is not required - defaults will be used if it is not found.</p><section> -<h3>Configuring your Local Repository</h3> +<h2>Configuring your Local Repository</h2> <p>The location of your local repository can be changed in your user configuration. The default value is <code>${user.home}/.m2/repository/</code>.</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><settings> +<div class="source"><pre class="prettyprint linenums"><settings> ... <localRepository>/path/to/local/repo/</localRepository> ... -</settings> -</code></pre></div> -<p><strong>Note:</strong> The local repository must be an absolute path.</p></section><section> -<h3>Configuring a Proxy</h3> +</settings></pre></div> +<p><b>Note:</b> The local repository must be an absolute path.</p></section><section> +<h2>Configuring a Proxy</h2> <p>Proxy configuration can also be specified in the settings file.</p> -<p>For more information, see the <a href="./guide-proxies.html">Guide to using a Proxy</a>.</p></section><section> -<h3>Configuring Parallel Artifact Resolution</h3> +<p>For more information, see the <a href="./guide-proxies.html"> Guide to using a Proxy</a>.</p></section><section> +<h2>Configuring Parallel Artifact Resolution</h2> <p>By default, Maven 2.1.0+ will download up to 5 artifacts (from different groups) at once. To change the size of the thread pool, start Maven using <code>-Dmaven.artifact.threads</code>. For example, to only download single artifacts at a time:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn -Dmaven.artifact.threads=1 verify -</code></pre></div> +<div> +<pre>mvn -Dmaven.artifact.threads=1 verify</pre></div> <p>You may wish to set this option permanently, in which case you can use the <code>MAVEN_OPTS</code> environment variable. For example:</p> - -<div class="source"><pre class="prettyprint linenums"><code>export MAVEN_OPTS=-Dmaven.artifact.threads=3 -</code></pre></div></section><section> -<h3>Security and Deployment Settings</h3> +<div> +<pre>export MAVEN_OPTS=-Dmaven.artifact.threads=3</pre></div></section><section> +<h2>Security and Deployment Settings</h2> <p>Repositories to deploy to are defined in a project in the <code><distributionManagement></code> section. However, you cannot put your username, password, or other security settings in that project. For that reason, you should add a server definition to your own settings with an <code>id</code> that matches that of the deployment repository in the project.</p> <p>In addition, some repositories may require authorization to download from, so the corresponding settings can be specified in a <code>server</code> element in the same way.</p> <p>Which settings are required will depend on the type of repository you are deploying to. As of the first release, only SCP deployments and file deployments are supported by default, so only the following SCP configuration is needed:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><settings> +<div class="source"><pre class="prettyprint linenums"><settings> ... <servers> <server> @@ -231,33 +202,26 @@ under the License. ... </servers> ... -</settings> -</code></pre></div> -<p>To encrypt passwords in these sections, refer to <a href="./guide-encryption.html">Encryption Settings</a>.</p></section><section> -<h3>Using Mirrors for Repositories</h3> -<p>Repositories can be declared inside a project, which means that if you have your own custom repositories, those sharing your project easily get the right settings out of the box. However, you may want to use an alternative mirror for a particular repository without changing the project files. Refer to <a href="./guide-mirror-settings.html">Guide to Mirror Settings</a> for more details.</p></section><section> -<h3>Profiles</h3> +</settings></pre></div> +<p>To encrypt passwords in these sections, refer to <a href="./guide-encryption.html"> Encryption Settings</a>.</p></section><section> +<h2>Using Mirrors for Repositories</h2> +<p>Repositories can be declared inside a project, which means that if you have your own custom repositories, those sharing your project easily get the right settings out of the box. However, you may want to use an alternative mirror for a particular repository without changing the project files. Refer to <a href="./guide-mirror-settings.html"> Guide to Mirror Settings</a> for more details.</p></section><section> +<h2>Profiles</h2> <p>Repository configuration can also be put into a profile. You can have multiple profiles, with one set to active so that you can easily switch environments. Read more about profiles in <a href="../introduction/introduction-to-profiles.html">Introduction to Build Profiles</a>.</p></section><section> -<h3>Optional configuration</h3> +<h2>Optional configuration</h2> <p>Maven will work for most tasks with the above configuration, however if you have any environmental specific configuration outside of individual projects then you will need to configure settings. The following sections refer to what is available.</p><section> -<h4>Settings</h4> +<h3>Settings</h3> <p>Maven has a settings file located in the Maven installation and/or user home directory that configure environmental specifics such as:</p> <ul> - -<li> -<p>HTTP proxy server</p></li> -<li> -<p>repository manager location</p></li> -<li> -<p>server authentication and passwords</p></li> -<li> -<p>other configuration properties</p></li> -</ul> +<li>HTTP proxy server</li> +<li>repository manager location</li> +<li>server authentication and passwords</li> +<li>other configuration properties</li></ul> <p>For information on this file, see the <a href="/settings.html">Settings reference</a></p></section><section> -<h4>Security</h4> +<h3>Security</h3> <p>As of Maven 2.1.0+, you can encrypt passwords in your settings file, however you must first configure a master password. For more information on both server passwords and the master password, see the <a href="./guide-encryption.html">Guide to Password Encryption</a>.</p></section><section> -<h4>Toolchains</h4> -<p>As of Maven 2.0.9+, you can build a project using a specific version of JDK independent from the one Maven is running with. For more information, see the <a href="./guide-using-toolchains.html">Guide to Using Toolchains</a>.</p></section></section></section></section> +<h3>Toolchains</h3> +<p>As of Maven 2.0.9+, you can build a project using a specific version of JDK independent from the one Maven is running with. For more information, see the <a href="./guide-using-toolchains.html">Guide to Using Toolchains</a>.</p></section></section></section> </main> </div> </div>
