Modified: maven/website/content/code-quality-management.html ============================================================================== --- maven/website/content/code-quality-management.html (original) +++ maven/website/content/code-quality-management.html Sun May 12 07:42:36 2024 @@ -2,15 +2,15 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/markdown/code-quality-management.md at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/markdown/code-quality-management.md at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> - <title>Maven</title> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> + <title>Maven â Code Quality Management</title> <link rel="stylesheet" href="./css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="./css/site.css" /> <link rel="stylesheet" href="./css/print.css" media="print" /> @@ -37,10 +37,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href="./" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href="./" id="bannerRight"><img src="images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -48,9 +46,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/code-quality-management.md";><img src="./images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">Code Quality Management <a href="https://github.com/apache/maven-site/tree/master/content/markdown/code-quality-management.md";><img src="./images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="download.cgi" title="Download">Download</a></li> @@ -129,7 +126,41 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section> +<section><section> +<h2>Code Quality Management</h2><!-- +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. +--> + +<p>Some existing Maven plugins use code analysis technologies (like +<a href="https://maven.apache.org/plugins/maven-checkstyle-plugin/"; class="externalLink">Checkstyle</a>, <a href="https://maven.apache.org/plugins/maven-pmd-plugin/"; class="externalLink">PMD</a>, <a href="https://mojohaus.org/jdepend-maven-plugin/"; class="externalLink">JDepend</a>, …) to generate various quality reports. This +page lists technologies and platforms that know how to aggregate all +this information to offer enhanced quality management functionalities.</p><section> +<h3>Quality management technologies and platforms</h3> +<p>Following is an alphabetical list of those we've heard mentioned around +the Maven community:</p> +<ul> + +<li><a href="https://hudson-ci.org"; class="externalLink">Hudson</a></li> +<li><a href="https://jenkins-ci.org"; class="externalLink">Jenkins</a></li> +<li><a href="http://www.sonarqube.org/"; class="externalLink">SonarQube</a></li> +<li><a href="http://www.squale.org/"; class="externalLink">Squale</a></li> +<li><a href="http://xradar.sourceforge.net"; class="externalLink">XRadar</a></li> +</ul></section></section></section> </main> </div> </div>
Modified: maven/website/content/community.html ============================================================================== --- maven/website/content/community.html (original) +++ maven/website/content/community.html Sun May 12 07:42:36 2024 @@ -2,15 +2,15 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/markdown/community.md at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/markdown/community.md at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> - <title>Maven</title> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> + <title>Maven â The Maven Community</title> <link rel="stylesheet" href="./css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="./css/site.css" /> <link rel="stylesheet" href="./css/print.css" media="print" /> @@ -37,10 +37,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href="./" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href="./" id="bannerRight"><img src="images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -48,9 +46,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/community.md";><img src="./images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">The Maven Community <a href="https://github.com/apache/maven-site/tree/master/content/markdown/community.md";><img src="./images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="download.cgi" title="Download">Download</a></li> @@ -129,7 +126,79 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section> +<section><section> +<h2>The Maven Community</h2><!-- +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. +--> + +<p>Maven, like any other open source project, relies heavily on the efforts +of the entire user community to contribute improvements, +report defects, communicate use cases, write documentation, +and assist other users in need. This is a quick guide outlining +what members of the Maven community can do to make the system work +better for everyone.</p><section> +<h3>Helping With Maven</h3> +<p>There is already a comprehensive <a href="./guides/development/guide-helping.html">Guide to Helping With +Maven</a>. That guide focuses upon +beginning as a supporter, with information on how to help the coding +effort.</p><section> +<h4>Commit Questions or Answers to the Maven User FAQ</h4> +<p>If you find things which are not correct or could be +explained in a better way or you simply miss things +do not hesitate to contact the maven community via +the users mailing list and tell us about it.</p></section><section> +<h4>Help Log Defects in JIRA</h4> +<p>Just as any other healthy project requires a quick turn-around on +defects, and a transparent method of users to have their wishes heard, +so too does Maven need your help. Refer to the <a href="./issue-management.html">Issue +Management</a> page.</p></section><section> +<h4>Developers</h4> +<p>For Maven developers, committers, PMC: there is a <a href="./developers/index.html">Developers +Guide</a>.</p></section></section><section> +<h3>Being a Good Maven Citizen</h3> +<p>The concept of a public repository built into the core architecture of +Maven makes it necessarily community-centric. There are a few simple +things that Maven users may do to help keep that community thriving.</p><section> +<h4>Be a Kind Public Repository User</h4> +<p>The best thing that a user can do is to set up their own remote +repository mirror containing the projects needed: this is called a +<a href=".//repository-management.html">repository manager</a>. This reduces strain +on the Maven central repository, and allows new users to get acquainted +with Maven easier and quicker. This is especially important for +power-users and corporations. The incentive behind this is, controlling +your own servers can give you desired level of security and more control +over uptime, resulting in a better experience for your users. With that +said, keep the following sentiment in mind:</p> +<p><em>DO NOT wget THE ENTIRE REPOSITORY!</em></p> +<p>Please take only the jars you need. We understand this is may entail +more work, but grabbing more than 1,7 TiB of binaries really kills our +servers.</p></section></section><section> +<h3>User Gathering Spots</h3> +<p>These are a few of the watering holes around which Maven users tend to +gather.</p><section> +<h4>Mailing Lists</h4> +<p>Maven has a number of <a href="./mailing-lists.html">Mailing Lists</a>, and the Maven +User List is specifically dedicated to answering questions about all +Maven things.</p></section><section> +<h4>Slack</h4> +<p>For people actively contributing to Maven, especially committers, there +is <a href="https://infra.apache.org"; class="externalLink">the ASF Slack workspace</a> available to discuss +issues, solve problems and build community in real-time.</p></section></section></section></section> </main> </div> </div> Modified: maven/website/content/configure.html ============================================================================== --- maven/website/content/configure.html (original) +++ maven/website/content/configure.html Sun May 12 07:42:36 2024 @@ -2,15 +2,15 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/markdown/configure.md at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/markdown/configure.md at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> - <title>Maven</title> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> + <title>Maven â Configuring Apache Maven</title> <link rel="stylesheet" href="./css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="./css/site.css" /> <link rel="stylesheet" href="./css/print.css" media="print" /> @@ -37,10 +37,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href="./" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href="./" id="bannerRight"><img src="images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -48,9 +46,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/configure.md";><img src="./images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">Configuring Apache Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/configure.md";><img src="./images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="download.cgi" title="Download">Download</a></li> @@ -136,7 +133,7 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section><a id="Configuring_Apache_Maven"></a> +<section> <h1>Configuring Apache Maven</h1><!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file @@ -157,18 +154,18 @@ under the License. --> <p>The configuration for Apache Maven usage itself and projects built with resides -in a number of places:</p><section><a id="MAVEN_OPTS_environment_variable.3A"></a> +in a number of places:</p><section> <h2><code>MAVEN_OPTS</code> environment variable:</h2> <p>This variable contains parameters used to start up the JVM running Maven and can be used to supply additional options to it. E.g. JVM memory -settings could be defined with the value <code>-Xms256m -Xmx512m</code>.</p></section><section><a id="MAVEN_ARGS_environment_variable.3A"></a> +settings could be defined with the value <code>-Xms256m -Xmx512m</code>.</p></section><section> <h2><code>MAVEN_ARGS</code> environment variable:</h2> <p>Starting with Maven 3.9.0, this variable contains arguments passed to Maven before CLI arguments. E.g., options and goals could be defined with the value -<code>-B -V checkstyle:checkstyle</code>.</p></section><section><a id="settings.xml_file.3A"></a> +<code>-B -V checkstyle:checkstyle</code>.</p></section><section> <h2><code>settings.xml</code> file:</h2> <p>Located in USER_HOME/.m2 the settings files is designed to contain any -configuration for Maven usage across projects.</p></section><section><a id="a.mvn_directory.3A"></a> +configuration for Maven usage across projects.</p></section><section> <h2><code>.mvn</code> directory:</h2> <p>Located within the project's <strong>top level directory</strong>, the files</p> <ul> @@ -178,7 +175,7 @@ configuration for Maven usage across pro <li><code>extensions.xml</code></li> </ul> <p>contain project specific configuration for running Maven.</p> -<p>This directory is part of the project and may be checked in into your version control.</p><section><a id="a.mvn.2Fextensions.xml_file.3A"></a> +<p>This directory is part of the project and may be checked in into your version control.</p><section> <h3><code>.mvn/extensions.xml</code> file:</h3> <p>The old way (up to Maven 3.2.5) was to create a jar (must be shaded if you have other dependencies) which contains the extension and put it manually into the <code>${MAVEN_HOME}/lib/ext</code> directory. This means you had to change the Maven installation. The consequence was that everyone @@ -187,6 +184,7 @@ option was to give the path to the jar o options to your Maven build every time you are calling Maven. Not very convenient as well.</p> <p>From now on this can be done much more simpler and in a more Maven like way. So you can define an <code>.mvn/extensions.xml</code> file which looks like the following:</p> +<div class="verbatim"> <pre><code class="language-xml"><extensions xmlns="http://maven.apache.org/EXTENSIONS/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.1.0 https://maven.apache.org/xsd/core-extensions-1.0.0.xsd"> <extension> @@ -195,8 +193,8 @@ options to your Maven build every time y <version/> </extension> </extensions> -</code></pre> -<p>Now you can simply use an extension by defining the usual maven coordinates groupId, artifactId, version as any other artifact. Furthermore all transitive dependencies of those extensions will automatically being downloaded from your repository. So no need to create a shaded artifact anymore.</p></section><section><a id="a.mvn.2Fmaven.config_file.3A"></a> +</code></pre></div> +<p>Now you can simply use an extension by defining the usual maven coordinates groupId, artifactId, version as any other artifact. Furthermore all transitive dependencies of those extensions will automatically being downloaded from your repository. So no need to create a shaded artifact anymore.</p></section><section> <h3><code>.mvn/maven.config</code> file:</h3> <p>It’s really hard to define a general set of options for calling the maven command line. Starting with Maven 3.3.1+, this can be solved by putting this @@ -206,19 +204,21 @@ configuration options for the <code>mvn< The <code>.mvn/maven.config</code> is located in the project's top level <code>.mvn</code> directory also works if in the root of a multi module build.</p> <p><strong>NOTICE</strong> starting with Maven <strong>3.9.0</strong> each single argument must be put in new line, so for the mentioned example your file will have content like:</p> +<div class="verbatim"> <pre><code>-T3 -U --fail-at-end -</code></pre></section><section><a id="a.mvn.2Fjvm.config_file.3A"></a> +</code></pre></div></section><section> <h3><code>.mvn/jvm.config</code> file:</h3> <p>Starting with Maven 3.3.1+ you can define JVM configuration via <code>.mvn/jvm.config</code> file which means you can define the options for your build on a per project base. This file will become part of your project and will be checked in along with your project. So no need anymore for <code>MAVEN_OPTS</code>, <code>.mavenrc</code> files.</p> <p>So for example if you put the following JVM options into the <code>.mvn/jvm.config</code> file</p> +<div class="verbatim"> <pre><code>-Xmx2048m -Xms1024m -XX:MaxPermSize=512m -Djava.awt.headless=true -</code></pre> -<p>You don't need to use these options in <code>MAVEN_OPTS</code> or switch between different configurations.</p></section></section><section><a id="Other_guides"></a> +</code></pre></div> +<p>You don't need to use these options in <code>MAVEN_OPTS</code> or switch between different configurations.</p></section></section><section> <h2>Other guides</h2> <p>The following guides contain further information to specific configuration aspects:</p> <ul> Modified: maven/website/content/developers/committer-environment.html ============================================================================== --- maven/website/content/developers/committer-environment.html (original) +++ maven/website/content/developers/committer-environment.html Sun May 12 07:42:36 2024 @@ -2,17 +2,17 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/committer-environment.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/committer-environment.apt at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> <meta name="author" content="Vincent Siveton" /> <meta name="date" content="2006-10-01" /> - <title>Maven</title> + <title>Maven â Developers centre - Committer Environment</title> <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../css/site.css" /> <link rel="stylesheet" href="../css/print.css" media="print" /> @@ -39,10 +39,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href=".././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -50,9 +48,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/committer-environment.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">Developers centre - Committer Environment <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/committer-environment.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="../scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="../download.cgi" title="Download">Download</a></li> @@ -148,14 +145,14 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section><a id="Committer_Environment"></a> -<h1>Committer Environment</h1><section><a id="Introduction"></a> +<section> +<h1>Committer Environment</h1><section> <h2>Introduction</h2> -<p>This document describes how to set up the Maven committer environment.</p></section><section><a id="Source_File_Encoding"></a> +<p>This document describes how to set up the Maven committer environment.</p></section><section> <h2>Source File Encoding</h2> -<p>When editing source files, make sure you use the right file encoding. For the Maven project, UTF-8 has been chosen as the default file encoding. UTF-8 is an encoding scheme for the Unicode character set that can encode all characters that Java can handle. The source files should not contain the byte order mark (BOM). There are exceptions to this general rule. For instance, properties files are encoded using ISO-8859-1 as per the JRE API, so please keep this in mind, too.</p></section><section><a id="Maven_Code_Style"></a> +<p>When editing source files, make sure you use the right file encoding. For the Maven project, UTF-8 has been chosen as the default file encoding. UTF-8 is an encoding scheme for the Unicode character set that can encode all characters that Java can handle. The source files should not contain the byte order mark (BOM). There are exceptions to this general rule. For instance, properties files are encoded using ISO-8859-1 as per the JRE API, so please keep this in mind, too.</p></section><section> <h2>Maven Code Style</h2> -<p>Refer to <a href="./conventions/code.html">Maven Code Style And Code Conventions</a></p></section><section><a id="Useful_software"></a> +<p>Refer to <a href="./conventions/code.html">Maven Code Style And Code Conventions</a></p></section><section> <h2>Useful software</h2> <p>The Maven Team uses assorted software. Here is a partial list:</p> <ul> Modified: maven/website/content/developers/committer-settings.html ============================================================================== --- maven/website/content/developers/committer-settings.html (original) +++ maven/website/content/developers/committer-settings.html Sun May 12 07:42:36 2024 @@ -2,18 +2,18 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/committer-settings.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/committer-settings.apt at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> <meta name="author" content="Vincent Siveton" /> <meta name="author" content="Dennis Lundberg" /> <meta name="date" content="2011-05-23" /> - <title>Maven</title> + <title>Maven â Developers centre - Committer Settings</title> <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../css/site.css" /> <link rel="stylesheet" href="../css/print.css" media="print" /> @@ -40,10 +40,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href=".././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -51,9 +49,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/committer-settings.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">Developers centre - Committer Settings <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/committer-settings.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="../scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="../download.cgi" title="Download">Download</a></li> @@ -149,13 +146,13 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section><a id="Introduction"></a> +<section> <h1>Introduction</h1> -<p>This document is intended to set up the Maven committer settings, i.e. the <code>${user.home}/.m2/settings.xml</code>.</p><section><a id="Enable_Apache_Servers"></a> +<p>This document is intended to set up the Maven committer settings, i.e. the <code>${user.home}/.m2/settings.xml</code>.</p><section> <h2>Enable Apache Servers</h2> <p>Maven uses several servers configuration to deploy snapshots and releases on the Apache servers. You need to tell to Maven what your Apache username is.</p> <p><b>It is highly recommended to use Maven's <a href="../guides/mini/guide-encryption.html"> password encryption capabilities</a> for your passwords</b>.</p> -<pre><code><settings> +<div class="verbatim source"><pre class="prettyprint linenums"><settings> ... <servers> <!-- To publish a snapshot of some part of Maven --> @@ -172,10 +169,10 @@ </server> ... </servers> -</settings></code></pre></section><section><a id="Enable_sending_announcement_e-mails"></a> +</settings></pre></div></section><section> <h2>Enable sending announcement e-mails</h2> <p>To be able to send out announcements of Maven releases you need to add a couple of properties to the <code>apache-release</code> profile.</p> -<pre><code><settings> +<div class="verbatim source"><pre class="prettyprint linenums"><settings> ... <profiles> <profile> @@ -187,7 +184,7 @@ </profile> ... </profiles> -</settings></code></pre></section></section> +</settings></pre></div></section></section> </main> </div> </div> Modified: maven/website/content/developers/compatibility-plan.html ============================================================================== --- maven/website/content/developers/compatibility-plan.html (original) +++ maven/website/content/developers/compatibility-plan.html Sun May 12 07:42:36 2024 @@ -2,17 +2,17 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/compatibility-plan.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/compatibility-plan.apt at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> <meta name="author" content="Hervé Boutemy" /> <meta name="date" content="2020-05-20" /> - <title>Maven</title> + <title>Maven â Maven Plugins Compatibility Plan</title> <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../css/site.css" /> <link rel="stylesheet" href="../css/print.css" media="print" /> @@ -39,10 +39,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href=".././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -50,9 +48,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/compatibility-plan.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">Maven Plugins Compatibility Plan <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/compatibility-plan.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="../scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="../download.cgi" title="Download">Download</a></li> @@ -148,15 +145,15 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section><a id="Maven_Plugins_Compatibility_Plan"></a> -<h1>Maven Plugins Compatibility Plan</h1><section><a id="Scope"></a> +<section> +<h1>Maven Plugins Compatibility Plan</h1><section> <h2>Scope</h2> <p>This page describes the system requirements plan, which consists of:</p> -<ol style="list-style-type: decimal;"> +<ol style="list-style-type: decimal"> <li>minimum <b>Java</b> runtime prerequisite for Maven plugins, which can be extended to shared components,</li> <li>minimum <b>Maven</b> runtime prerequisite for plugins.</li></ol> <p>Such requirements are displayed as "System Requirements" in every plugin info report (see <a href="/plugins/maven-clean-plugin/plugin-info.html">this example</a>).</p> -<p>Consolidated view for all LATEST plugins release is visible in a <a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool-prerequisites.html";>daily generated report</a>.</p></section><section><a id="Maven_Plan"></a> +<p>Consolidated view for all LATEST plugins release is visible in a <a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool-prerequisites.html";>daily generated report</a>.</p></section><section> <h2>Maven Plan</h2> <ul> <li>Until 2012, Maven 2.2.1 + Java 5 prerequisites, with plugins versions in 2.x</li> @@ -164,7 +161,7 @@ <li>Since June 2020, Maven Plugin API used by plugins >= 3.1.0 + Java 8 prerequisites <a class="externalLink" href="https://s.apache.org/MVN-PLUGIN-MIGRATION-3.1";>Technical details</a></li> <li>In March 2023, Maven before 3.2.5 has been <a href="/docs/history.html#maven-3-6-x-and-before">marked as EOL</a>, meaning that plugins should use 3.2.5 as minimum</li> <li>In April 2023, Maven before 3.6.3 has been <a href="/docs/history.html#maven-3-6-x-and-before">marked as EOL</a>, meaning that plugins should use 3.6.3 as minimum</li> -<li>In February 2024, Maven 4 after 4.0.0-alpha-12 will require Java 17 (as per <a class="externalLink" href="https://lists.apache.org/thread/bfkvvjftrxypp06yj8zj919fcz0dt2zt";>vote on the Mailing List</a>).</li></ul></section><section><a id="Context"></a> +<li>In February 2024, Maven 4 after 4.0.0-alpha-12 will require Java 17 (as per <a class="externalLink" href="https://lists.apache.org/thread/bfkvvjftrxypp06yj8zj919fcz0dt2zt";>vote on the Mailing List</a>).</li></ul></section><section> <h2>Context</h2> <ul> <li>Maven core history with Java prerequisite is available in the <a href="/docs/history.html">release notes</a></li> Modified: maven/website/content/developers/conventions/code.html ============================================================================== --- maven/website/content/developers/conventions/code.html (original) +++ maven/website/content/developers/conventions/code.html Sun May 12 07:42:36 2024 @@ -2,17 +2,17 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/conventions/code.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/conventions/code.apt at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> <meta name="author" content="Vincent Siveton" /> <meta name="date" content="2008-07-05" /> - <title>Maven</title> + <title>Maven â Maven Code Style And Code Conventions</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> @@ -39,10 +39,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href="../.././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -50,9 +48,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/conventions/code.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">Maven Code Style And Code Conventions <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/conventions/code.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="../../download.cgi" title="Download">Download</a></li> @@ -141,7 +138,7 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section><a id="Maven_Code_Style_And_Code_Conventions"></a> +<section> <h1>Maven Code Style And Code Conventions</h1> <p>This document describes the rules for how the sources should be formatted in order to improve consistency, readability and maintainability.</p> <p>As the formatting is automatically enforced or even applied with <a class="externalLink" href="https://github.com/diffplug/spotless/tree/main/plugin-maven";>spotless-maven-plugin</a> for all projects using <a href="/pom/maven/index.html">Maven Project Parent POM 38 or newer</a> developers usually don't need to care and the following sections are just for informational purposes.</p> @@ -160,7 +157,7 @@ <li><a href="#Generic_XML_Code_Convention">Generic XML Code Convention</a></li> <li><a href="#POM_Code_Convention">POM Code Convention</a></li> <li><a href="#XDOC_Code_Convention">XDOC Code Convention</a></li> -<li><a href="#FML_Code_Convention">FML Code Convention</a></li></ul></li></ul><section><a id="Generic_Code_Style_And_Convention"></a> +<li><a href="#FML_Code_Convention">FML Code Convention</a></li></ul></li></ul><section> <h2>Generic Code Style And Convention</h2> <p>All working files (java, xml, others) should respect the following conventions:</p> <ul> @@ -200,25 +197,25 @@ <ul> <li><b>Indentation</b>: Always use 2 space indents, unless you're wrapping a new XML tags line in which case you should indent 4 spaces.</li> <li><b>Line Breaks</b>: Always use a new line with indentation for complex XML types and no line break for simple XML types. Always use a new line to separate XML sections or blocks, for instance: -<pre><code><aTag> +<div class="verbatim source"><pre class="prettyprint linenums"><aTag> <simpleType>This is a simple type</simpleType> <complexType> <simpleType>This is a complex type</simpleType> </complexType> -</aTag></code></pre> +</aTag></pre></div> <p>In some cases, adding comments could improve the readability of blocks, for instance:</p> -<pre><code> <!-- Simple XML documentation --></code></pre> +<div class="verbatim source"><pre class="prettyprint linenums"> <!-- Simple XML documentation --></pre></div> <p>or</p> -<pre><code> <!-- ====================================================================== --> +<div class="verbatim source"><pre class="prettyprint linenums"> <!-- ====================================================================== --> <!-- Block documentation --> - <!-- ====================================================================== --></code></pre></li></ul></section><section> + <!-- ====================================================================== --></pre></div></li></ul></section><section> <h3><a id="Generic_XML_Code_Convention">Generic XML Code Convention</a></h3> <p>No generic code convention exists yet for XML files.</p></section><section> <h3><a id="POM_Code_Convention">POM Code Convention</a></h3> <p>The team has <a class="externalLink" href="https://lists.apache.org/thread/h8px5t6f3q59cnkzpj1t02wsoynr3ygk";>voted</a> during the end of June 2008 to follow a specific POM convention to ordering POM elements. The consequence of this vote is that the <a class="externalLink" href="https://maven.apache.org/ref/current/maven-model/maven.html";>Maven project descriptor</a> is <b>no more</b> considered as the reference for the ordering.</p> <p>The following is the recommended ordering for all Maven POM files:</p> -<pre><code><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> +<div class="verbatim source"><pre class="prettyprint linenums"><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion/> <parent/> @@ -262,9 +259,9 @@ <reporting/> <profiles/> -</project></code></pre> +</project></pre></div> <p><b>Comments</b>:</p> -<ol style="list-style-type: decimal;"> +<ol style="list-style-type: decimal"> <li>The <project/> element is always on one line.</li> <li>The blocks are voluntary separated by a new line to improve the readingness.</li> <li>The dependencies in <dependencies/> and <dependencyManagement/> tags have no specific ordering. Developers are free to choose the ordering, but grouping dependencies by topics (like groupId i.e. <code>org.apache.maven</code>) is a good practice.</li></ol></section><section> Modified: maven/website/content/developers/conventions/git.html ============================================================================== --- maven/website/content/developers/conventions/git.html (original) +++ maven/website/content/developers/conventions/git.html Sun May 12 07:42:36 2024 @@ -2,17 +2,17 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/conventions/git.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/conventions/git.apt at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> <meta name="author" content="Olivier Lamy" /> <meta name="date" content="2012-09-12" /> - <title>Maven</title> + <title>Maven â Maven Git Convention</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> @@ -39,10 +39,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href="../.././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -50,9 +48,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/conventions/git.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">Maven Git Convention <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/conventions/git.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="../../download.cgi" title="Download">Download</a></li> @@ -141,56 +138,62 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section><a id="Maven_Git_Convention"></a> +<section> <h1>Maven Git Convention</h1> -<p>This document describes how developers should use Git. </p><section><a id="Git_Configuration"></a> -<h2>Git Configuration</h2><section><a id="For_contributors_who_are_not_committers"></a> +<p>This document describes how developers should use Git. </p><section> +<h2>Git Configuration</h2><section> <h3>For contributors who are not committers</h3> <p>Apache git repositories are at <i> <<git://git.apache.org</i>>>. However, the ASF uses clones on github.com to make it easier for people to contribute changes via pull requests.</p> <p>To contribute to a Maven component that is maintained in git, please follow these steps:</p> -<ol style="list-style-type: decimal;"> +<ol style="list-style-type: decimal"> <li>create a JIRA for bug or improvement that you wish to work on. The Maven project uses JIRA to organize and track our work, and in particular to keep track of which changes are included in which releases.</li> <li>Make a fork of the official ASF clone from github.com. For example, <code>https://github.com/apache/maven-scm</code>.</li> <li>Make a branch named after your JIRA ticket. This is not <i>required</i>, but it makes it easier for Maven committers to keep track of your contribution.</li> <li>Make your changes. As always, unit or integration tests make it much easier for us to accept your changes.</li> -<li>Make a pull request to pull your changes to the official clone. Add a link to your pull request to the JIRA. Committers will take it from here.</li></ol></section><section><a id="For_committers"></a> +<li>Make a pull request to pull your changes to the official clone. Add a link to your pull request to the JIRA. Committers will take it from here.</li></ol></section><section> <h3>For committers</h3> <p>Committers may, of course, commit directly to the ASF repositories. For complex changes, you may find it valuable to make a pull request at github to make it easier to collaborate with others.</p><section> <h4><a id="Commit_Message_Template">Commit Message Template</a></h4> <p>Commits should be focused on one issue at a time, because that makes it easier for others to review the commit.</p> <p>A commit message should use this template:</p> +<div class="verbatim"> <pre>[ISSUE-1] <<Summary field from JIRA>> Submitted by: <<Name of non-committer>> -o Comments</pre> +o Comments</pre></div> <p>Where:</p> <ul> <li><b>ISSUE-1</b> can be omitted if there was no relevant JIRA issue, though you are strongly encouraged to create one for significant changes.</li> <li><b>Submitted by</b> only needs to be specified when a patch is being applied for a non-committer.</li> <li><b>Comments</b> some optional words about the solution.</li></ul> <p>eg:</p> +<div class="verbatim"> <pre>[MNG-1456] Added the foo to the bar Submitted by: Baz Bazman -o Applied without change</pre></section></section></section><section><a id="Apply_User_Patch"></a> +o Applied without change</pre></div></section></section></section><section> <h2>Apply User Patch</h2> <p>To keep the history of contributions clear, The committer should usually apply the patch without any <b>major</b> modifications, and then create his or her own commits for further modifications. However, committers should never commit code to a live branch which is not suitable to release. If a contribution requires significant work to make it useful, commit it to a branch, fix it up, and merge the branch.</p> <p>If the user created a pull request, the committer is responsible for closing that pull request. You do this by adding a note to a commit message:</p> -<pre> Closes #NNN.</pre> -<p>where NNN is the number of the pull request.</p></section><section><a id="Edit_Commit_Message"></a> +<div class="verbatim"> +<pre> Closes #NNN.</pre></div> +<p>where NNN is the number of the pull request.</p></section><section> <h2>Edit Commit Message</h2> <p>to edit last commit comment:</p> -<pre>$ git commit --amend -m "new comment"</pre></section><section><a id="Workflow"></a> +<div class="verbatim"> +<pre>$ git commit --amend -m "new comment"</pre></div></section><section> <h2>Workflow</h2> <p>Workflow for svn folks is something like :</p> +<div class="verbatim"> <pre> $ git pull $ hack hack hack $ git push // fails, because someone else has already pushed to master $ git pull // this creates some merges - $ git push</pre> + $ git push</pre></div> <p>A more quiet workflow :</p> +<div class="verbatim"> <pre>$ git pull $ hack hack hack $ git push @@ -199,37 +202,43 @@ $ git fetch // this moves 'origin/master' $ git rebase origin/master // this reapplies your local changes on top of origin/master -$ git push</pre></section><section><a id="Other_useful_Git_commands_while_developing"></a> +$ git push</pre></div></section><section> <h2>Other useful Git commands while developing</h2> <p>If you've done a chunk of work and you would like to ditch your changes and start from scratch use this command to revert to the original checkout:</p> -<pre>$ git checkout .</pre> -<p>TODO .gitignore</p><section><a id="power-git_checkout"></a> +<div class="verbatim"> +<pre>$ git checkout .</pre></div> +<p>TODO .gitignore</p><section> <h3>power-git checkout</h3> <p>This checkout is typical for highly experienced git users, and may serve as inspiration for others; as usual the best way to learn is by doing. Sample shown for maven-surefire</p> <p>Go to https://github.com/apache/maven-surefire and fork surefire to your own github account.</p> <p>Starting with nothing (no existing clone)</p> +<div class="verbatim"> <pre>git clone https://github.com/<youraccount>/maven-surefire.git git remote add apache https://git-wip-us.apache.org/repos/asf/maven-surefire.git git remote add asfgithub https://github.com/apache/maven-surefire.git git config --add remote.asfgithub.fetch "+refs/pull/*/head:refs/remotes/asfgithub/pr/*" -git fetch --all</pre> +git fetch --all</pre></div> <p>(You may consider adding --global to the git config statement above to always fetch pull requests for any remote named "asfgithub")</p> <p>In this setup, running "git push" will normally push to your personal github account. Furthermore, all pull requests from github are also fetched to your local clone, use</p> -<pre>gitk --all</pre> +<div class="verbatim"> +<pre>gitk --all</pre></div> <p>to try to make some sense of it all. This is an important command to understand! (gitk may need to be installed additionally)</p> <p>gitk also has a quite excellent context menu that is far more context sensitive than most people realize at first impression. Right-clicking on a commit in a github pull-request will allow you to cherry-pick straight in the gui.</p> <p>If you're working on the master branch, you can do stuff like this:</p> +<div class="verbatim"> <pre>git push # your github account -git push apache # the authoritative apache repo</pre> +git push apache # the authoritative apache repo</pre></div> <p>Using your github account as a storage for half-finished work is excellent if you switch between multiple computers, always push to github before leaving your current computer and start by pulling at the next computer.</p> <p>To merge a pull request</p> +<div class="verbatim"> <pre>git merge pr/10 # merge pull request number 10 from asf@github into master -git push apache # upload to apache</pre> +git push apache # upload to apache</pre></div> <p>Or if you're comfortable with rebasing;</p> +<div class="verbatim"> <pre> git checkout pr/10 git rebase apache/master -git push apache</pre></section></section></section> +git push apache</pre></div></section></section></section> </main> </div> </div> Modified: maven/website/content/developers/conventions/jira.html ============================================================================== --- maven/website/content/developers/conventions/jira.html (original) +++ maven/website/content/developers/conventions/jira.html Sun May 12 07:42:36 2024 @@ -2,15 +2,15 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/markdown/developers/conventions/jira.md at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/markdown/developers/conventions/jira.md at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> - <title>Maven</title> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> + <title>Maven â Maven JIRA Conventions</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> @@ -37,10 +37,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href="../.././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -48,9 +46,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/conventions/jira.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">Maven JIRA Conventions <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/conventions/jira.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="../../download.cgi" title="Download">Download</a></li> @@ -139,7 +136,67 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section> +<section><section> +<h2>Maven JIRA Conventions</h2><!-- +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. +--> + +<p>This document describes how Maven developers should use JIRA, our issue management system.</p><section> +<h3>When To Create a JIRA Issue?</h3> +<p>This section discusses when to create a JIRA issue versus just committing a change in Git (eventually through a PR).</p> +<ul> + +<li> +<p><strong>Minor changes</strong> such as code reformatting, documentation fixes, etc. that aren't going to impact other users +can be committed without a JIRA issue.</p></li> +<li> +<p><strong>Larger changes</strong> such as bug fixes, API changes, significant refactoring, new classes, and pretty much any change +of more than 100 lines, should have JIRA tickets.</p></li> +</ul> +<p>Creating a JIRA issue and referring it in the commit comments simplifies tracking the changes that happen in a release, +using JIRA automatic release notes creation.</p></section><section> +<h3>How To Use Issue Details?</h3> +<p>This section presents some conventions about the issue fields.</p><section> +<h4>Priority</h4> +<p>Committers have the responsibility to realign priority by editing the issue.</p> +<p><em>Reasoning</em>: having a correct release note</p></section><section> +<h4>Assignee</h4> +<p>Committers can assign an issue to a specific committer that person seems to +be well placed to address it.</p></section><section> +<h4>Component/s</h4> +<p>Committers have the responsibility to specify the correct component by editing the issue.</p> +<p><em>Reasoning</em>: having a correct release note.</p></section><section> +<h4>Affects Version/s</h4> +<p>By default, the Maven team considers that an issue which affects a given version also affects preceding versions. For example, an issue +that affects Maven 3.6.3 also affects 3.6.0, 3.6.1, 3.6.2. +If it is a regression, the committers should specify the affected versions.</p> +<p><em>Reasoning</em>: having a correct release note.</p></section><section> +<h4>Fix Version/s</h4> +<p>Update to correct version after merging to master.</p></section><section> +<h4>Time Tracking</h4> +<p>The Maven team doesn't use this. Committers can if it helps them.</p></section></section><section> +<h3>Further Links</h3> +<ul> + +<li><a href="https://confluence.atlassian.com/jira064/jira-documentation-720411693.html"; class="externalLink">JIRA Documentation</a></li> +<li><a href="https://confluence.atlassian.com/jira064/what-is-an-issue-720416138.html"; class="externalLink">What is an Issue?</a></li> +<li><a href="https://confluence.atlassian.com/jira064/what-is-a-project-720416135.html"; class="externalLink">What is a project?</a></li> +</ul></section></section></section> </main> </div> </div> Modified: maven/website/content/developers/dependency-policies.html ============================================================================== --- maven/website/content/developers/dependency-policies.html (original) +++ maven/website/content/developers/dependency-policies.html Sun May 12 07:42:36 2024 @@ -2,17 +2,17 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/dependency-policies.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/dependency-policies.apt at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> <meta name="author" content="Stephen Connolly" /> <meta name="date" content="2011-02-01" /> - <title>Maven</title> + <title>Maven â Maven Dependency Policies</title> <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../css/site.css" /> <link rel="stylesheet" href="../css/print.css" media="print" /> @@ -39,10 +39,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href=".././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -50,9 +48,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/dependency-policies.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">Maven Dependency Policies <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/dependency-policies.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="../scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="../download.cgi" title="Download">Download</a></li> @@ -148,24 +145,24 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section><a id="Maven_Dependency_Policies"></a> -<h1>Maven Dependency Policies</h1><section><a id="Scope"></a> +<section> +<h1>Maven Dependency Policies</h1><section> <h2>Scope</h2> <p>This page describes the policies around the use of dependencies by the Apache Maven Developers in the process of developing Apache Maven itself.</p> <p>This page does not apply to projects hosted outside of the Apache Maven project. In order to remove all doubt, this page only applies to code which has a Github URL that starts with <code>https://github.com/apache/maven</code> or a Gitbox URL starting with <code>https://gitbox.apache.org/repos/asf?p=maven</code></p> -<p>If you have stumbled across this page and you are working on code that does not have a Github URL starting with <code>https://github.com/apache/maven</code> then this page does not apply to you.</p></section><section><a id="Background"></a> +<p>If you have stumbled across this page and you are working on code that does not have a Github URL starting with <code>https://github.com/apache/maven</code> then this page does not apply to you.</p></section><section> <h2>Background</h2> <p>The Apache Maven PMC is tasked with ensuring (among other things) that all legal issues are addressed and that each and every release is the product of the community as a whole.</p> <p>The Apache Maven project consists of quite a number of components. For the purposes of this policy, we will make a distinction between the core Maven distribution and all the other components.</p> -<p>The core Maven distribution is the binary and source distributions made available from the https://maven.apache.org/download page. </p></section><section><a id="Applicability"></a> +<p>The core Maven distribution is the binary and source distributions made available from the https://maven.apache.org/download page. </p></section><section> <h2>Applicability</h2> -<p>This policy applies to all changes to dependencies as and from Subversion revision 1067464.</p></section><section><a id="Core_Maven_Distribution_Dependencies"></a> +<p>This policy applies to all changes to dependencies as and from Subversion revision 1067464.</p></section><section> <h2>Core Maven Distribution Dependencies</h2> <p>All dependencies which are included in the Core Maven Distribution must either:</p> <ul> <li>be licensed under a <a class="externalLink" href="https://www.apache.org/legal/resolved.html#category-a";>Category A license</a>; or</li> <li>be licensed under a <a class="externalLink" href="https://www.apache.org/legal/resolved.html#category-b";>Category B license</a> and approved by a majority vote of the Apache Maven PMC.</li></ul> -<p>Votes for Category B licenses will be held on the d...@maven.apache.org mailing list. A majority of the PMC must vote in favour of a Category B licensed dependency before a release can be made containing that dependency.</p></section><section><a id="Non-Core_Dependencies"></a> +<p>Votes for Category B licenses will be held on the d...@maven.apache.org mailing list. A majority of the PMC must vote in favour of a Category B licensed dependency before a release can be made containing that dependency.</p></section><section> <h2>Non-Core Dependencies</h2> <p>Non-Core components may only use Category A or Category B licenses.</p></section></section> </main> Modified: maven/website/content/developers/index.html ============================================================================== --- maven/website/content/developers/index.html (original) +++ maven/website/content/developers/index.html Sun May 12 07:42:36 2024 @@ -2,18 +2,18 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/index.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/index.apt at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> <meta name="author" content="Vincent Siveton" /> <meta name="author" content="Brett Porter" /> <meta name="date" content="2015-02-14" /> - <title>Maven</title> + <title>Maven â Maven Developer Centre</title> <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../css/site.css" /> <link rel="stylesheet" href="../css/print.css" media="print" /> @@ -40,10 +40,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href=".././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -51,9 +49,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/index.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">Maven Developer Centre <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/index.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="../scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="../download.cgi" title="Download">Download</a></li> @@ -142,10 +139,10 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section><a id="Maven_Developer_Centre"></a> +<section> <h1>Maven Developer Centre</h1> <p>This documentation centre is for people who are Maven developers, or would like to contribute.</p> -<p>If you cannot find your answers here, feel free to ask the <a class="externalLink" href="mailto:d...@maven.apache.org";>Maven Developer List</a>.</p><section><a id="Contributors_Resources"></a> +<p>If you cannot find your answers here, feel free to ask the <a class="externalLink" href="mailto:d...@maven.apache.org";>Maven Developer List</a>.</p><section> <h2>Contributors Resources</h2> <ul> <li><a href="../guides/development/guide-helping.html">Guide to helping with Maven</a></li> @@ -154,8 +151,8 @@ <li><a href="../scm.html">Source Code</a></li> <li><a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/";>Continuous Integration</a></li> <li><a href="../plugin-developers/common-bugs.html">Common Bugs and Pitfalls</a></li> -<li><a href="../project-roles.html">Apache Maven Project Roles</a></li></ul></section><section><a id="Committers_Resources"></a> -<h2>Committers Resources</h2><section><a id="General_Resources"></a> +<li><a href="../project-roles.html">Apache Maven Project Roles</a></li></ul></section><section> +<h2>Committers Resources</h2><section> <h3>General Resources</h3> <ul> <li><a href="./welcome-to-new-committers.html">Guide for new Maven committers</a></li> @@ -164,21 +161,21 @@ <li><a href="./retirement-plan-plugins.html">Retirement Plan for Plugins</a></li> <li><a href="./dependency-policies.html">Maven Dependency Policies</a></li> <li><a href="./compatibility-plan.html">Maven Plugins and Components Compatibility Plan</a></li> -<li><a class="externalLink" href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=5964567";>Maven Proposals/Backlog</a></li></ul></section></section><section><a id="Developers_Conventions"></a> +<li><a class="externalLink" href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=5964567";>Maven Proposals/Backlog</a></li></ul></section></section><section> <h2>Developers Conventions</h2> <p>There are a number of conventions used in the Maven projects, which contributors and developers alike should follow for consistency's sake.</p> <ul> <li><a href="./conventions/code.html">Maven Code Style And Conventions</a></li> <li><a href="./conventions/jira.html">Maven JIRA Convention</a></li> <li><a href="./conventions/git.html">Maven Git Convention</a></li></ul> -<p><b>Note</b>: If you cannot find your answers here, feel free to ask the <a class="externalLink" href="mailto:d...@maven.apache.org";>Maven Developer List</a>.</p></section><section><a id="Making_Releases"></a> +<p><b>Note</b>: If you cannot find your answers here, feel free to ask the <a class="externalLink" href="mailto:d...@maven.apache.org";>Maven Developer List</a>.</p></section><section> <h2>Making Releases</h2> <ul> <li><a href="./release/pmc-gpg-keys.html">Making GPG Keys</a></li> -<li><a href="./release/index.html">Release Process</a></li></ul></section><section><a id="Maven_Website"></a> +<li><a href="./release/index.html">Release Process</a></li></ul></section><section> <h2>Maven Website</h2> <ul> -<li><a href="./website/index.html">Deploy Maven Website</a></li></ul></section><section><a id="Other_Resources"></a> +<li><a href="./website/index.html">Deploy Maven Website</a></li></ul></section><section> <h2>Other Resources</h2> <ul> <li><a class="externalLink" href="https://www.apache.org/dev/";>ASF Development Infrastructure Information</a></li> Modified: maven/website/content/developers/mojo-api-specification.html ============================================================================== --- maven/website/content/developers/mojo-api-specification.html (original) +++ maven/website/content/developers/mojo-api-specification.html Sun May 12 07:42:36 2024 @@ -2,16 +2,16 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/xdoc/developers/mojo-api-specification.xml at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/xdoc/developers/mojo-api-specification.xml at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> <meta name="author" content="John Casey" /> - <title>Maven</title> + <title>Maven â Mojo API Specification</title> <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../css/site.css" /> <link rel="stylesheet" href="../css/print.css" media="print" /> @@ -38,10 +38,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href=".././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -49,9 +47,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/xdoc/developers/mojo-api-specification.xml";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">Mojo API Specification <a href="https://github.com/apache/maven-site/tree/master/content/xdoc/developers/mojo-api-specification.xml";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="../scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="../download.cgi" title="Download">Download</a></li> @@ -144,7 +141,7 @@ <main id="bodyColumn" class="span10" > - <section><a id="Introduction"></a> + <section> <h1>Introduction</h1> <p>Maven plugins can be written in Java or any of a @@ -157,7 +154,7 @@ <p>Although the requirements on Mojos are minimal by design, there are still a very few requirements that Mojo developers must keep in mind:</p> -<ol style="list-style-type: decimal;"> +<ol style="list-style-type: decimal"> <li>a Mojo must have a method named <code>execute</code> which declares no parameters, and has a void return type. If this method @@ -176,7 +173,7 @@ covered in more detail below.</li> </ol> - <section><a id="Mojo_Code"></a> + <section> <h2>Mojo Code</h2> <p>Basically, these Mojo requirements are embodied by the @@ -190,7 +187,7 @@ </p> </section> - <section><a id="The_Descriptor_and_Annotations"></a> + <section> <h2>The Descriptor and Annotations</h2> <p>As mentioned before, each Plugin - or packaged set of Mojos - must @@ -204,7 +201,7 @@ </p> </section> - <section><a id="Project_Descriptor_.28POM.29_Requirements"></a> + <section> <h2>Project Descriptor (POM) Requirements</h2> <p>The POM must declare a packaging element which describes this project as a Maven plugin project: @@ -219,7 +216,7 @@ - <section><a id="Resources"></a> + <section> <h1>Resources</h1> <p>This section simply gives a listing of pointers for more Modified: maven/website/content/developers/release/index.html ============================================================================== --- maven/website/content/developers/release/index.html (original) +++ maven/website/content/developers/release/index.html Sun May 12 07:42:36 2024 @@ -2,17 +2,17 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M18 from content/apt/developers/release/index.apt at 2024-05-11 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/developers/release/index.apt at 2024-05-12 | Rendered using Apache Maven Fluido Skin 2.0.0-M6 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <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-M18" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M10" /> <meta name="author" content="Jason van Zyl" /> <meta name="date" content="2010-07-26" /> - <title>Maven</title> + <title>Maven â Releasing A Maven Project</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-2.0.0-M6.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> <link rel="stylesheet" href="../../css/print.css" media="print" /> @@ -39,10 +39,8 @@ <div class="container-fluid"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><h1>Apache Maven Site</h1> -</a></div> - <div class="pull-right"><a href="../.././" id="bannerRight"><h1>$esc.xml( $banner.name )</h1> -</a></div> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site" style="" /></a></div> + <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" alt="" style="" /></a></div> <div class="clear"><hr/></div> </div> @@ -50,9 +48,8 @@ <ul class="breadcrumb"> <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - - <li class="active ">Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/release/index.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-11</li> + <li class="active ">Releasing A Maven Project <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/release/index.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-05-12</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> <li class="pull-right"><a href="../../download.cgi" title="Download">Download</a></li> @@ -147,7 +144,7 @@ </div> </header> <main id="bodyColumn" class="span10" > -<section><a id="Releasing_A_Maven_Project"></a> +<section> <h1>Releasing A Maven Project</h1> <p>What follows is a description of releasing a Maven project to a staging repository and its documentation, whereupon it is scrutinized by the community, approved, and transferred to a production repository.</p> <p>The steps involved are similar for any Apache project, with more specifics for parent POMs and Maven itself. The steps involved, and the relevant documents for each, are listed below.</p>
