You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by sv...@apache.org on 2023/02/18 20:40:59 UTC
svn commit: r1907743 [2/21] - in /maven/website/content: ./ archives/maven-2.x/ developers/ developers/conventions/ developers/release/ developers/website/ docs/ docs/3.2.1/ docs/3.2.2/ docs/3.2.3/ docs/3.2.5/ docs/3.3.1/ docs/3.3.3/ docs/3.3.9/ docs/3...
Modified: maven/website/content/developers/conventions/code.html
==============================================================================
--- maven/website/content/developers/conventions/code.html (original)
+++ maven/website/content/developers/conventions/code.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/developers/conventions/code.md at 2023-02-18
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/developers/conventions/code.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 ">Maven Code Style And Code Conventions <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/conventions/code.md"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></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: 2023-02-18</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../../scm.html" title="Get Sources">Get Sources</a></li>
@@ -133,147 +133,84 @@
</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>Maven Code Style And Code Conventions</h2>
+<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 href="https://github.com/diffplug/spotless/tree/main/plugin-maven" class="externalLink">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>
-<p>Optionally you can still import the code style formatter for your IDE from <a href="https://gitbox.apache.org/repos/asf?p=maven-shared-resources.git;a=tree;f=src/main/resources/config;hb=HEAD" class="externalLink">shared-resources</a></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>
+<p>Optionally you can still import the code style formatter for your IDE from <a class="externalLink" href="https://gitbox.apache.org/repos/asf?p=maven-shared-resources.git;a=tree;f=src/main/resources/config;hb=HEAD">shared-resources</a></p>
<ul>
-
-<li>
-<p><a href="#generic-code-style-and-convention">Generic Code Style And Convention</a></p></li>
-<li>
-<p><a href="#java">Java</a></p></li>
-<li>
-<p><a href="#java-code-style">Java Code Style</a></p></li>
-<li>
-<p><a href="#java-code-convention">Java Code Convention</a></p></li>
-<li>
-<p><a href="#java-code-convention---import-layouts">Java Code Convention - import layouts</a></p></li>
-<li>
-<p><a href="#javadoc-convention">JavaDoc Convention</a></p></li>
-<li>
-<p><a href="#xml">XML</a></p></li>
-<li>
-<p><a href="#xml-code-style">XML Code Style</a></p></li>
-<li>
-<p><a href="#generic-xml-code-convention">Generic XML Code Convention</a></p></li>
-<li>
-<p><a href="#pom-code-convention">POM Code Convention</a></p></li>
-<li>
-<p><a href="#xdoc-code-convention">XDOC Code Convention</a></p></li>
-<li>
-<p><a href="#fml-code-convention">FML Code Convention</a></p></li>
-</ul><section>
-<h3>Generic Code Style And Convention</h3>
+<li><a href="#Generic_Code_Style_And_Convention">Generic Code Style And Convention</a></li>
+<li><a href="#Java">Java</a>
+<ul>
+<li><a href="#Java_Code_Style">Java Code Style</a></li>
+<li><a href="#Java_Code_Convention">Java Code Convention</a></li>
+<li><a href="#Java_Code_Convention_-_import_layouts">Java Code Convention - import layouts</a></li>
+<li><a href="#JavaDoc_Convention">JavaDoc Convention</a></li></ul></li>
+<li><a href="#XML">XML</a>
+<ul>
+<li><a href="#XML_Code_Style">XML Code Style</a></li>
+<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>
+<h2>Generic Code Style And Convention</h2>
<p>All working files (java, xml, others) should respect the following conventions:</p>
<ul>
-
-<li>
-<p><strong>License Header</strong>: Always add the current <a href="https://www.apache.org/legal/src-headers.html#headers" class="externalLink">ASF license header</a> in all files checked into the source code repository.</p></li>
-<li>
-<p><strong>Trailing Whitespace</strong>: No trailing whitespaces allowed.</p></li>
-</ul>
+<li><b>License Header</b>: Always add the current <a class="externalLink" href="https://www.apache.org/legal/src-headers.html#headers">ASF license header</a> in all files checked into the source code repository.</li>
+<li><b>Trailing Whitespace</b>: No trailing whitespaces allowed. </li></ul>
<p>and the following style:</p>
<ul>
-
-<li>
-<p><strong>Indentation</strong>: <strong>Never</strong> use tabs!</p></li>
-<li>
-<p><strong>Line wrapping</strong>: Always use a 120-column line width.</p></li>
-</ul>
-<p><strong>Note</strong>: The specific styles and conventions, listed in the next sections, can override these generic rules.</p></section><section>
-<h3>Java</h3><section>
-<h4>Java Code Style</h4>
-<p>Maven adopts the <a href="https://github.com/palantir/palantir-java-format" class="externalLink">palantir Java format</a>.</p></section><section>
-<h4>Java Code Convention</h4>
+<li><b>Indentation</b>: <b>Never</b> use tabs!</li>
+<li><b>Line wrapping</b>: Always use a 120-column line width.</li></ul>
+<p><b>Note</b>: The specific styles and conventions, listed in the next sections, can override these generic rules.</p></section><section>
+<h2><a id="Java">Java</a></h2><section>
+<h3><a id="Java_Code_Style">Java Code Style</a></h3>
+<p>Maven adopts the <a class="externalLink" href="https://github.com/palantir/palantir-java-format">palantir Java format</a>.</p></section><section>
+<h3><a id="Java_Code_Convention">Java Code Convention</a></h3>
<p>For consistency reasons, our Java code convention is mainly:</p>
<ul>
-
-<li>
-<p><strong>Naming</strong>: Constants (i.e. static final members) should always be in upper case. Use short, descriptive names for classes and methods.</p></li>
-<li>
-<p><strong>Organization</strong>: Avoid using public inner classes. Prefer interfaces instead of default implementation.</p></li>
-<li>
-<p><strong>Modifier</strong>: Avoid using final modifier on all fields and arguments. Prefer using private or protected fields instead of public fields.</p></li>
-<li>
-<p><strong>Exceptions</strong>: Throw meaningful exceptions to make debugging and testing easier.</p></li>
-<li>
-<p><strong>Documentation</strong>: Document public interfaces well, i.e. all non-trivial public and protected functions should include Javadoc that indicates what they do.</p></li>
-<li>
-<p><strong>Testing</strong>: All non-trivial public classes should have corresponding unit or integration tests.</p></li>
-</ul></section><section>
-<h4>Java Code Convention - import layouts</h4>
+<li><b>Naming</b>: Constants (i.e. static final members) should always be in upper case. Use short, descriptive names for classes and methods.</li>
+<li><b>Organization</b>: Avoid using public inner classes. Prefer interfaces instead of default implementation.</li>
+<li><b>Modifier</b>: Avoid using final modifier on all fields and arguments. Prefer using private or protected fields instead of public fields.</li>
+<li><b>Exceptions</b>: Throw meaningful exceptions to make debugging and testing easier.</li>
+<li><b>Documentation</b>: Document public interfaces well, i.e. all non-trivial public and protected functions should include Javadoc that indicates what they do.</li>
+<li><b>Testing</b>: All non-trivial public classes should have corresponding unit or integration tests.</li></ul></section><section>
+<h3><a id="Java_Code_Convention_-_import_layouts">Java Code Convention - import layouts</a></h3>
<p>For consistency reasons, Java imports should be organized as:</p>
<ul>
-
-<li>
-<p>import <strong>javax.*</strong></p></li>
-<li>
-<p>import <strong>java.*</strong></p></li>
-<li>
-<p>blank line</p></li>
-<li>
-<p>import <strong>all other imports</strong></p></li>
-</ul>
+<li>import <b>javax.*</b></li>
+<li>import <b>java.*</b></li>
+<li>blank line</li>
+<li>import <b>all other imports</b></li></ul>
<p>all imports in each group should be sorted alphabetically.</p>
-<p>To ensure a package import order consistent with the layout described above, download <code>[maven-eclipse-importorder.txt](https://gitbox.apache.org/repos/asf?p=maven-shared-resources.git;a=blob_plain;f=src/main/resources/config/maven-eclipse-importorder.txt;hb=HEAD)</code>, select <em>Window > Preferences</em> and navigate to <em>Java > Code Style > Organize Imports</em>. Click on <em>Import…</em> and select the downloaded file to change the import order.</p></section><section>
-<h4>JavaDoc Convention</h4>
+<p>To ensure a package import order consistent with the layout described above, download <code><a class="externalLink" href="https://gitbox.apache.org/repos/asf?p=maven-shared-resources.git;a=blob_plain;f=src/main/resources/config/maven-eclipse-importorder.txt;hb=HEAD">maven-eclipse-importorder.txt</a></code>, select <i>Window > Preferences</i> and navigate to <i>Java > Code Style > Organize Imports</i>. Click on <i>Import...</i> and select the downloaded file to change the import order.</p></section><section>
+<h3><a id="JavaDoc_Convention">JavaDoc Convention</a></h3>
<p>TO BE DISCUSSED</p></section></section><section>
-<h3>XML</h3><section>
-<h4>XML Code Style</h4>
+<h2><a id="XML">XML</a></h2><section>
+<h3><a id="XML_Code_Style">XML Code Style</a></h3>
<p>The Maven style for XML files is mainly:</p>
<ul>
-
-<li>
-<p><strong>Indentation</strong>: Always use 2 space indents, unless you're wrapping a new XML tags line in which case you should indent 4 spaces.</p></li>
-<li>
-<p><strong>Line Breaks</strong>: 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:</p></li>
-</ul>
-
-<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><aTag>
+<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:
+<div class="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></div>
+</aTag></pre></div>
<p>In some cases, adding comments could improve the readability of blocks, for instance:</p>
-
-<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> <!-- Simple XML documentation -->
-</code></pre></div>
+<div class="source"><pre class="prettyprint linenums"> <!-- Simple XML documentation --></pre></div>
<p>or</p>
-
-<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> <!-- ====================================================================== -->
+<div class="source"><pre class="prettyprint linenums"> <!-- ====================================================================== -->
<!-- Block documentation -->
- <!-- ====================================================================== -->
-</code></pre></div></section><section>
-<h4>Generic XML Code Convention</h4>
+ <!-- ====================================================================== --></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>
-<h4>POM Code Convention</h4>
-<p>The team has <a href="https://lists.apache.org/thread/h8px5t6f3q59cnkzpj1t02wsoynr3ygk" class="externalLink">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 href="https://maven.apache.org/ref/current/maven-model/maven.html" class="externalLink">Maven project descriptor</a> is <strong>no more</strong> considered as the reference for the ordering.</p>
+<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>
-
-<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><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="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/>
@@ -317,28 +254,21 @@ under the License.
<reporting/>
<profiles/>
-</project>
-</code></pre></div>
-<p><strong>Comments</strong>:</p>
-<p>1 The <code><project></code> element is always on one line.</p>
-<p>1 The blocks are voluntary separated by a new line to improve the readiness.</p>
-<p>1 The dependencies in <code><dependencies></code> and <code><dependencyManagement></code> 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.</p></section><section>
-<h4>XDOC Code Convention</h4>
+</project></pre></div>
+<p><b>Comments</b>:</p>
+<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>
+<h3><a id="XDOC_Code_Convention">XDOC Code Convention</a></h3>
<p>For consistency and readability reasons, XDOC files should respect:</p>
<ul>
-
-<li>
-<p><strong>Metadata</strong>: Always specify metadata in the <code><properties></code> tag.</p></li>
-<li>
-<p><strong>Sections</strong>: Always use a new line with indentation for <code><section></code> tags.</p></li>
-</ul></section><section>
-<h4>FML Code Convention</h4>
+<li><b>Metadata</b>: Always specify metadata in the <properties/> tag.</li>
+<li><b>Sections</b>: Always use a new line with indentation for <section/> tags.</li></ul></section><section>
+<h3><a id="FML_Code_Convention">FML Code Convention</a></h3>
<p>For readability reasons, FML files should respect:</p>
<ul>
-
-<li><strong>FAQ</strong>: Always use a new line with indentation for <code><faq></code> tags.</li>
-</ul><!-- * {APT} Do we need any specific APT style/convention? -->
-</section></section></section></section>
+<li><b>FAQ</b>: Always use a new line with indentation for <faq/> tags.</li></ul></section></section></section>
</main>
</div>
</div>
Modified: maven/website/content/developers/conventions/git.html
==============================================================================
--- maven/website/content/developers/conventions/git.html (original)
+++ maven/website/content/developers/conventions/git.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/developers/conventions/git.md at 2023-02-18
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/developers/conventions/git.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 ">Maven Git Convention <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/conventions/git.md"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></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: 2023-02-18</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../../scm.html" title="Get Sources">Get Sources</a></li>
@@ -133,90 +133,63 @@
</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>Maven Git Convention</h2>
-<p>This document describes how developers should use Git.</p><section>
-<h3>Git Configuration</h3><section>
-<h4>For contributors who are not committers</h4>
-<p>Apache git repositories are at <em><a href="git://git.apache.org" class="externalLink">git://git.apache.org</a></em>. However, the ASF uses clones on github.com to make it easier for people to contribute changes via pull requests.</p>
+<section>
+<h1>Maven Git Convention</h1>
+<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>
-<p>1 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.</p>
-<p>1 Make a fork of the official ASF clone from github.com. For example, <code>https://github.com/apache/maven-scm</code>.</p>
-<p>1 Make a branch named after your JIRA ticket. This is not <em>required</em>, but it makes it easier for Maven committers to keep track of your contribution.</p>
-<p>1 Make your changes. As always, unit or integration tests make it much easier for us to accept your changes.</p>
-<p>1 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.</p></section><section>
-<h4>For committers</h4>
+<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>
+<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>
-<h5>Commit Message Template</h5>
+<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="source"><pre class="prettyprint linenums"><code>[ISSUE-1] <<Summary field from JIRA>>
+<div>
+<pre>[ISSUE-1] <<Summary field from JIRA>>
Submitted by: <<Name of non-committer>>
-o Comments
-</code></pre></div>
+o Comments</pre></div>
<p>Where:</p>
<ul>
-
-<li>
-<p><strong>ISSUE-1</strong> can be omitted if there was no relevant JIRA issue, though you are strongly encouraged to create one for significant changes.</p></li>
-<li>
-<p><strong>Submitted by</strong> only needs to be specified when a patch is being applied for a non-committer.</p></li>
-<li>
-<p><strong>Comments</strong> some optional words about the solution.</p></li>
-</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="source"><pre class="prettyprint linenums"><code>[MNG-1456] Added the foo to the bar
+<div>
+<pre>[MNG-1456] Added the foo to the bar
Submitted by: Baz Bazman
-o Applied without change
-</code></pre></div></section></section></section><section>
-<h3>Apply User Patch</h3>
-<p>To keep the history of contributions clear, The committer should usually apply the patch without any <strong>major</strong> 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>
+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>
-
-<div class="source"><pre class="prettyprint linenums"><code> Closes #NNN.
-</code></pre></div>
+<div>
+<pre> Closes #NNN.</pre></div>
<p>where NNN is the number of the pull request.</p></section><section>
-<h3>Edit Commit Message</h3>
+<h2>Edit Commit Message</h2>
<p>to edit last commit comment:</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>git commit --amend -m "new comment"
-</code></pre></div></section><section>
-<h3>Workflow</h3>
+<div>
+<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="source"><pre class="prettyprint linenums"><code class="language-bash"> $ git pull
+<div>
+<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
-</code></pre></div>
+ $ git push</pre></div>
<p>A more quiet workflow :</p>
-
-<div class="source"><pre class="prettyprint linenums"><code class="language-bash">$ git pull
+<div>
+<pre>$ git pull
$ hack hack hack
$ git push
// fails, because someone else has already pushed to master
@@ -224,50 +197,43 @@ $ git fetch
// this moves 'origin/master'
$ git rebase origin/master
// this reapplies your local changes on top of origin/master
-$ git push
-</code></pre></div></section><section>
-<h3>Other useful Git commands while developing</h3>
+$ 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>
-
-<div class="source"><pre class="prettyprint linenums"><code>git checkout .
-</code></pre></div>
+<div>
+<pre>$ git checkout .</pre></div>
<p>TODO .gitignore</p><section>
-<h4>power-git checkout</h4>
+<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 <a href="https://github.com/apache/maven-surefire" class="externalLink">https://github.com/apache/maven-surefire</a> and fork surefire to your own github account.</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="source"><pre class="prettyprint linenums"><code>git clone https://github.com/<youraccount>/maven-surefire.git
+<div>
+<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
-</code></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>
-
-<div class="source"><pre class="prettyprint linenums"><code>gitk --all
-</code></pre></div>
+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>
+<div>
+<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="source"><pre class="prettyprint linenums"><code>git push # your github account
-git push apache # the authoritative apache repo
-</code></pre></div>
+<div>
+<pre>git push # your github account
+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="source"><pre class="prettyprint linenums"><code>git merge pr/10 # merge pull request number 10 from asf@github into master
-git push apache # upload to apache
-</code></pre></div>
+<div>
+<pre>git merge pr/10 # merge pull request number 10 from asf@github into master
+git push apache # upload to apache</pre></div>
<p>Or if you're comfortable with rebasing;</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>
+<div>
+<pre>
git checkout pr/10
git rebase apache/master
-git push apache
-</code></pre></div></section></section></section></section>
+git push apache</pre></div></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 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/developers/dependency-policies.md at 2023-02-18
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/developers/dependency-policies.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 ">Maven Dependency Policies <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/dependency-policies.md"><img src="../images/accessories-text-editor.png" title="Edit" /></a></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: 2023-02-18</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../scm.html" title="Get Sources">Get Sources</a></li>
@@ -140,48 +140,26 @@
</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>Maven Dependency Policies</h2><section>
-<h3>Scope</h3>
+<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>
-<h3>Background</h3>
+<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 <a href="https://maven.apache.org/download" class="externalLink">https://maven.apache.org/download</a> page.</p></section><section>
-<h3>Applicability</h3>
+<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>
-<h3>Core Maven Distribution Dependencies</h3>
+<h2>Core Maven Distribution Dependencies</h2>
<p>All dependencies which are included in the Core Maven Distribution must either:</p>
<ul>
-
-<li>
-<p>be licensed under a <a href="https://www.apache.org/legal/resolved.html#category-a" class="externalLink">Category A license</a>; or</p></li>
-<li>
-<p>be licensed under a <a href="https://www.apache.org/legal/resolved.html#category-b" class="externalLink">Category B license</a> and approved by a majority vote of the Apache Maven PMC.</p></li>
-</ul>
-<p>Votes for Category B licenses will be held on the <a href="mailto:dev@maven.apache.org" class="externalLink">dev@maven.apache.org</a> 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>
-<h3>Non-Core Dependencies</h3>
-<p>Non-Core components may only use Category A or Category B licenses.</p></section></section></section>
+<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 dev@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>
</div>
</div>
Modified: maven/website/content/developers/index.html
==============================================================================
--- maven/website/content/developers/index.html (original)
+++ maven/website/content/developers/index.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/developers/index.md at 2023-02-18
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/developers/index.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="Vincent Siveton, Brett Porter" />
+ <meta name="author" content="Vincent Siveton
+Brett Porter" />
<meta name="date" content="2015-02-14" />
<title>Maven – Maven Developer Centre</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 ">Maven Developer Centre <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/index.md"><img src="../images/accessories-text-editor.png" title="Edit" /></a></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: 2023-02-18</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../scm.html" title="Get Sources">Get Sources</a></li>
@@ -133,101 +134,47 @@
</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>Maven Developer Centre</h2>
+<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 href="mailto:dev@maven.apache.org" class="externalLink">Maven Developer List</a>.</p><section>
-<h3>Contributors Resources</h3>
-<ul>
-
-<li>
-<p><a href="../guides/development/guide-helping.html">Guide to helping with Maven</a></p></li>
-<li>
-<p><a href="../guides/development/guide-maven-development.html">Developing Maven</a></p></li>
-<li>
-<p><a href="../guides/development/guide-building-maven.html">Building Maven</a></p></li>
-<li>
-<p><a href="../scm.html">Source Code</a></p></li>
-<li>
-<p><a href="https://ci-maven.apache.org/job/Maven/job/maven-box/" class="externalLink">Continuous Integration</a></p></li>
-<li>
-<p><a href="../plugin-developers/common-bugs.html">Common Bugs and Pitfalls</a></p></li>
-<li>
-<p><a href="../project-roles.html">Apache Maven Project Roles</a></p></li>
-</ul></section><section>
-<h3>Committers Resources</h3><section>
-<h4>General Resources</h4>
+<p>If you cannot find your answers here, feel free to ask the <a class="externalLink" href="mailto:dev@maven.apache.org">Maven Developer List</a>.</p><section>
+<h2>Contributors Resources</h2>
<ul>
-
-<li>
-<p><a href="./welcome-to-new-committers.html">Guide for new Maven committers</a></p></li>
-<li>
-<p><a href="./committer-environment.html">Committer Environment</a></p></li>
-<li>
-<p><a href="./committer-settings.html">Committer Settings</a></p></li>
-<li>
-<p><a href="./retirement-plan-plugins.html">Retirement Plan for Plugins</a></p></li>
-<li>
-<p><a href="./dependency-policies.html">Maven Dependency Policies</a></p></li>
-<li>
-<p><a href="./compatibility-plan.html">Maven Plugins and Components Compatibility Plan</a></p></li>
-<li>
-<p><a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=5964567" class="externalLink">Maven Proposals/Backlog</a></p></li>
-</ul></section></section><section>
-<h3>Developers Conventions</h3>
+<li><a href="../guides/development/guide-helping.html">Guide to helping with Maven</a></li>
+<li><a href="../guides/development/guide-maven-development.html">Developing Maven</a></li>
+<li><a href="../guides/development/guide-building-maven.html">Building Maven</a></li>
+<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>
+<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>
+<li><a href="./committer-environment.html">Committer Environment</a></li>
+<li><a href="./committer-settings.html">Committer Settings</a></li>
+<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>
+<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>
-<p><a href="./conventions/code.html">Maven Code Style And Conventions</a></p></li>
-<li>
-<p><a href="./conventions/jira.html">Maven JIRA Convention</a></p></li>
-<li>
-<p><a href="./conventions/git.html">Maven Git Convention</a></p></li>
-</ul>
-<p><strong>Note</strong>: If you cannot find your answers here, feel free to ask the <a href="mailto:dev@maven.apache.org" class="externalLink">Maven Developer List</a>.</p></section><section>
-<h3>Making Releases</h3>
-<ul>
-
-<li>
-<p><a href="./release/pmc-gpg-keys.html">Making GPG Keys</a></p></li>
-<li>
-<p><a href="./release/index.html">Release Process</a></p></li>
-</ul></section><section>
-<h3>Maven Website</h3>
+<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:dev@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>
+<h2>Maven Website</h2>
<ul>
-
-<li><a href="./website/index.html">Deploy Maven Website</a></li>
-</ul></section><section>
-<h3>Other Resources</h3>
+<li><a href="./website/index.html">Deploy Maven Website</a></li></ul></section><section>
+<h2>Other Resources</h2>
<ul>
-
-<li>
-<p><a href="https://www.apache.org/dev/" class="externalLink">ASF Development Infrastructure Information</a></p></li>
-<li>
-<p><a href="https://www.apache.org/foundation/" class="externalLink">About the Apache Software Foundation</a></p></li>
-</ul><!-- TODO: tasks as buttons? -->
-<!-- TODO: de-dupe with existing documents in community -->
-<!-- TODO: clean up, have cookbook with more in depth documents like cutting releases, etc. -->
-</section></section></section>
+<li><a class="externalLink" href="https://www.apache.org/dev/">ASF Development Infrastructure Information</a></li>
+<li><a class="externalLink" href="https://www.apache.org/foundation/">About the Apache Software Foundation</a></li></ul></section></section>
</main>
</div>
</div>
Modified: maven/website/content/developers/release/index.html
==============================================================================
--- maven/website/content/developers/release/index.html (original)
+++ maven/website/content/developers/release/index.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/developers/release/index.md at 2023-02-18
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/developers/release/index.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 ">Releasing A Maven Project <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/release/index.md"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></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: 2023-02-18</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../../scm.html" title="Get Sources">Get Sources</a></li>
@@ -139,42 +139,16 @@
</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>Releasing A Maven Project</h2>
+<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><!-- nothing specific: normal component * {{{./maven-plugin-release.html} Releasing a Maven plugin project}} -->
-<!-- nothing specific: normal component * {{{./maven-shared-release.html} Releasing a Maven shared component or subproject}} -->
-
+<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>
<ul>
-
-<li>
-<p><a href="./maven-core-release.html">Releasing Maven Core</a></p></li>
-<li>
-<p><a href="./parent-pom-release.html">Releasing a parent POM</a></p></li>
-</ul>
+<li><a href="./maven-core-release.html"> Releasing Maven Core</a></li>
+<li><a href="./parent-pom-release.html"> Releasing a parent POM</a></li></ul>
<p>The above links all provide specific information for those types of releases, but they all refer back to the common documentation:</p>
<ul>
-
-<li><a href="./maven-project-release-procedure.html">Maven Project Common Release procedure</a></li>
-</ul></section></section>
+<li><a href="./maven-project-release-procedure.html"> Maven Project Common Release procedure</a></li></ul></section>
</main>
</div>
</div>
Modified: maven/website/content/developers/release/maven-project-release-procedure.html
==============================================================================
--- maven/website/content/developers/release/maven-project-release-procedure.html (original)
+++ maven/website/content/developers/release/maven-project-release-procedure.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/developers/release/maven-project-release-procedure.md at 2023-02-18
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/developers/release/maven-project-release-procedure.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, Karl Heinz Marbaise" />
+ <meta name="author" content="Jason van Zyl
+Karl Heinz Marbaise" />
<meta name="date" content="2018-04-07" />
<title>Maven – Releasing A Maven Project</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 ">Releasing A Maven Project <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/release/maven-project-release-procedure.md"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li class="active ">Releasing A Maven Project <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/release/maven-project-release-procedure.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>
@@ -139,65 +140,36 @@
</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>Performing a Maven Project Release</h2>
+<section>
+<h1>Performing a Maven Project Release</h1>
<p>This document covers the common release procedures used by the Maven team to perform releases.</p><section>
-<h3>Prerequisites</h3>
+<h2><a id="Prerequisites">Prerequisites</a></h2>
<p>Be sure that:</p>
<ul>
-
-<li>
-<p>you have a recent Git client installed and on your shell's path.</p></li>
-<li>
-<p>you have JDK 8 installed and on your shell's path to build Maven 3.7.0+. Details about minimum JDK version to build an appropriate version can be found here: <a href="/docs/history.html">https://maven.apache.org/docs/history.html</a></p></li>
-<li>
-<p>if you receive an OutOfMemoryError during the build, make sure to have set the environment variable <code>MAVEN_OPTS=-Xmx512m</code></p></li>
-<li>
-<p>you must use Maven 3.3.9+.</p></li>
-<li>
-<p>follow Apache environment configuration steps outlined at: <a href="https://www.apache.org/dev/publishing-maven-artifacts.html#dev-env" class="externalLink">Publishing Maven Artifacts</a>.</p></li>
-</ul></section><section>
-<h3>Before you begin</h3>
+<li>you have a recent Git client installed and on your shell's path.</li>
+<li>you have JDK 8 installed and on your shell's path to build Maven 3.7.0+. Details about minimum JDK version to build an appropriate version can be found here: <a href="/docs/history.html">https://maven.apache.org/docs/history.html</a></li>
+<li>if you receive an OutOfMemoryError during the build, make sure to have set the environment variable <code>MAVEN_OPTS=-Xmx512m</code></li>
+<li>you must use Maven 3.3.9+.</li>
+<li>follow Apache environment configuration steps outlined at: <a class="externalLink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#dev-env">Publishing Maven Artifacts</a>.</li></ul></section><section>
+<h2>Before you begin</h2>
<p>If you started here, you may first want to review one of the following documents that cover the specifics of various types of releases we have in the Maven Project:</p>
<ul>
-
-<li>
-<p><a href="./maven-core-release.html">Releasing Maven Core</a></p></li>
-<li>
-<p><a href="./parent-pom-release.html">Releasing a parent POM</a></p></li>
-</ul></section><section>
-<h3>Consider updating the parent versions</h3>
+<li><a href="./maven-core-release.html"> Releasing Maven Core</a></li>
+<li><a href="./parent-pom-release.html"> Releasing a parent POM</a></li></ul></section><section>
+<h2>Consider updating the parent versions</h2>
<p>If the item you are planning to release is not using the most recent version of its parent (see <a href="../../pom/">parent POMs</a> index), consider taking this opportunity to update to it.</p></section><section>
-<h3>Make sure that site compilation works</h3>
+<h2>Make sure that site compilation works</h2>
<p>Particularly if you update the parent or if you updated your javadoc, the site compilation process may fail, or reveal a conspicuous error. It is stressful and time-consuming to discover this *after* you stage a release and then try to follow the procedure to deploy the site for review. So you may find it more pleasant to check out the state of the site before you start:</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>mvn -Preporting site site:stage
-</code></pre></div></section><section>
-<h3>Stage the Release</h3>
-<p>1 Follow the release preparation, staging and closing the repository steps outlined in <a href="https://infra.apache.org/publishing-maven-artifacts.html" class="externalLink">Publishing Maven Releases</a>.</p>
-<p>1 Stage the latest documentation as explained in <a href="../website/deploy-component-reference-documentation.html">deploying Maven components reference documentation</a>.</p></section><section>
-<h3>Call the vote</h3>
+<div>
+<pre>mvn -Preporting site site:stage</pre></div></section><section>
+<h2>Stage the Release</h2>
+<ol style="list-style-type: decimal">
+<li>Follow the release preparation, staging and closing the repository steps outlined in <a class="externalLink" href="https://infra.apache.org/publishing-maven-artifacts.html">Publishing Maven Releases</a>. </li>
+<li>Stage the latest documentation as explained in <a href="../website/deploy-component-reference-documentation.html">deploying Maven components reference documentation</a>.</li></ol></section><section>
+<h2>Call the vote</h2>
<p>Propose a vote on the dev list with the closed issues, the issues left, the staging repository and the staging site. For instance:</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>To: "Maven Developers List" <dev@maven.apache.org>
+<div>
+<pre>To: "Maven Developers List" <dev@maven.apache.org>
Subject: [VOTE] Release Apache Maven XXX Plugin version Y.Z
Hi,
@@ -226,27 +198,25 @@ Vote open for at least 72 hours.
[ ] +1
[ ] +0
[ ] -1
-
-</code></pre></div>
-<p>To get the JIRA release notes link, browse to the plugin's or component's JIRA page, select the <em>Road Map</em> link, and use the link to <em>Release Notes</em> that is next to the version being released.</p>
-<p>To get the list of issues left in JIRA, browse to the plugin's or component's JIRA page, and from the <em>Preset Filters</em> on the right, use the link for <em>Outstanding</em> issues.</p>
+</pre></div>
+<p>To get the JIRA release notes link, browse to the plugin's or component's JIRA page, select the <i>Road Map</i> link, and use the link to <i>Release Notes</i> that is next to the version being released.</p>
+<p>To get the list of issues left in JIRA, browse to the plugin's or component's JIRA page, and from the <i>Preset Filters</i> on the right, use the link for <i>Outstanding</i> issues.</p>
<p>The vote is open for at least 72 hours means, that you need to wait at least 72 hours before proceeding. This gives others time to test your release and check that everything is good. If you have received after that not enough +1 votes to reach the quorum, this doesn't mean, the vote failed. It just takes a bit longer.</p></section><section>
-<h3>Check the vote results</h3>
-<p>Copied from <a href="https://www.apache.org/foundation/voting.html#ReleaseVotes" class="externalLink">Votes on Package Releases</a>.</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>Votes on whether a package is ready to be released use majority approval
+<h2>Check the vote results</h2>
+<p>Copied from <a class="externalLink" href="https://www.apache.org/foundation/voting.html#ReleaseVotes">Votes on Package Releases</a>.</p>
+<div>
+<pre>Votes on whether a package is ready to be released use majority approval
-- i.e. at least three PMC members must vote affirmatively for release,
and there must be more positive than negative votes. Releases may not be vetoed.
Generally the community will cancel the release vote if anyone identifies serious problems,
but in most cases the ultimate decision, lies with the individual serving as release manager.
The specifics of the process may vary from project to project,
-but the 'minimum quorum of three +1 votes' rule is universal.
-</code></pre></div>
-<p>The list of PMC members is available at <a href="https://people.apache.org/committers-by-project.html#maven-pmc" class="externalLink">https://people.apache.org/committers-by-project.html#maven-pmc</a>.</p><section>
-<h4>Successful vote</h4>
-<p>Once a vote is <strong>successful</strong>, post the result to the <code>dev</code> list and cc the <code>PMC</code>. For instance:</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>To: "Maven Developers List" <dev@maven.apache.org>
+but the 'minimum quorum of three +1 votes' rule is universal.</pre></div>
+<p>The list of PMC members is available at <a class="externalLink" href="https://people.apache.org/committers-by-project.html#maven-pmc">https://people.apache.org/committers-by-project.html#maven-pmc</a>.</p><section>
+<h3>Successful vote</h3>
+<p>Once a vote is <b>successful</b>, post the result to the <code>dev</code> list and cc the <code>PMC</code>. For instance:</p>
+<div>
+<pre>To: "Maven Developers List" <dev@maven.apache.org>
CC: "Maven Project Management Committee List" <private@maven.apache.org>
Subject: [RESULT] [VOTE] Release Apache Maven XXX Plugin version Y.Z
@@ -258,77 +228,63 @@ The vote has passed with the following r
PMC quorum: ...
-I will promote the source release zip file to Apache distribution area and the artifacts to the central repo.
-</code></pre></div>
+I will promote the source release zip file to Apache distribution area and the artifacts to the central repo.</pre></div>
<p>Follow the procedure to the end.</p></section><section>
-<h4>Unsuccessful vote</h4>
-<p>Once a vote is <strong>unsuccessful</strong>, post the result to the <code>dev</code> list, For instance:</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>To: "Maven Developers List" <dev@maven.apache.org>
+<h3>Unsuccessful vote</h3>
+<p>Once a vote is <b>unsuccessful</b>, post the result to the <code>dev</code> list, For instance:</p>
+<div>
+<pre>To: "Maven Developers List" <dev@maven.apache.org>
Subject: [CANCEL] [VOTE] Release Apache Maven XXX Plugin version Y.Z
Hi,
-The vote has been canceled.
-</code></pre></div>
+The vote has been canceled.</pre></div>
<p>For canceled vote the process will need to be restarted.</p>
<p>Be sure to:</p>
<ul>
-
-<li>
-<p>drop your staging repository as described in <a href="https://www.apache.org/dev/publishing-maven-artifacts.html" class="externalLink">Drop a repository</a></p></li>
-<li>
-<p>create new version for next round <code>Y.Z+1</code></p></li>
-<li>
-<p>assign issues from version <code>Y.Z</code> also to version <code>Y.Z+1</code></p></li>
-<li>
-<p>mark the <code>Y.Z</code> version as <strong>archived</strong></p></li>
-<li>
-<p>report found issues and assign them to version <code>Y.Z+1</code></p></li>
-<li>
-<p>fix found issues</p></li>
-</ul>
+<li>drop your staging repository as described in <a class="externalLink" href="https://www.apache.org/dev/publishing-maven-artifacts.html">Drop a repository</a></li>
+<li>create new version for next round <code>Y.Z+1</code></li>
+<li>assign issues from version <code>Y.Z</code> also to version <code>Y.Z+1</code></li>
+<li>mark the <code>Y.Z</code> version as <b>archived</b></li>
+<li>report found issues and assign them to version <code>Y.Z+1</code></li>
+<li>fix found issues</li></ul>
<p>Start the process for version <code>Y.Z+1</code> from the beginning.</p></section></section><section>
-<h3>Copy the source release to the Apache Distribution Area</h3>
-<p>The official Apache release is the ‘source-release’ bundle distributed in <code>www.apache.org/dist</code>, as described in <a href="https://www.apache.org/dev/release-distribution" class="externalLink">Apache Release Distribution Policy</a>. All releases for Maven must be copied to <a href="https://www.apache.org/dist/maven/" class="externalLink">the official Maven release area</a>.</p>
-<p>The release area is maintained with svnpubsub. To deliver a release, you add it to <a href="https://dist.apache.org/repos/dist/release/maven" class="externalLink">the subversion repository for the dist area</a>: add the release, its signature and sha512 checksum files, copying them from <code>target/checkout/target/</code> directory created during <code>mvn release:perform</code> step. Currently this requires to be in maven-pmc group (see <a href="https://issues.apache.org/jira/browse/INFRA-5945" class="externalLink">INFRA-5945</a>). If you are not a PMC member, drop a line to <em><a href="mailto:private@maven.apache.org" class="externalLink">private@maven.apache.org</a></em> and ask them to do this step (and the next one) for you: the PMC member will get the source release bundle and its signature from Nexus staging repository and will create sha512 checksum file by hand, for example using shell:</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>for f in *.zip ; do echo -n $(sha512sum $f | cut -c -128) > $f.sha512 ; done
-</code></pre></div>
+<h2>Copy the source release to the Apache Distribution Area</h2>
+<p>The official Apache release is the 'source-release' bundle distributed in <code>www.apache.org/dist</code>, as described in <a class="externalLink" href="https://www.apache.org/dev/release-distribution">Apache Release Distribution Policy</a>. All releases for Maven must be copied to <a class="externalLink" href="https://www.apache.org/dist/maven/">the official Maven release area</a>.</p>
+<p>The release area is maintained with svnpubsub. To deliver a release, you add it to <a class="externalLink" href="https://dist.apache.org/repos/dist/release/maven">the subversion repository for the dist area</a>: add the release, its signature and sha512 checksum files, copying them from <code>target/checkout/target/</code> directory created during <code>mvn release:perform</code> step. Currently this requires to be in maven-pmc group (see <a class="externalLink" href="https://issues.apache.org/jira/browse/INFRA-5945">INFRA-5945</a>). If you are not a PMC member, drop a line to <i>private@maven.apache.org</i> and ask them to do this step (and the next one) for you: the PMC member will get the source release bundle and its signature from Nexus staging repository and will create sha512 checksum file by hand, for example using shell:</p>
+<div>
+<pre>for f in *.zip ; do echo -n $(sha512sum $f | cut -c -128) > $f.sha512 ; done</pre></div>
<p>For example:</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>wagon/wagon-2.2-source-release.zip
+<div>
+<pre>wagon/wagon-2.2-source-release.zip
wagon/wagon-2.2-source-release.zip.asc
-wagon/wagon-2.2-source-release.zip.sha512
-</code></pre></div>
-<p>You should also run ‘svn rm’ as needed to clear out older releases. As per <a href="https://www.apache.org/legal/release-policy.html#where-do-releases-go" class="externalLink">Apache Release Policy</a>, only the latest release on a branch should stay in the main dist areas. So long as the previous release is at least a day old, the automatic archiver will have copied it to the archive.</p>
-<p>To check that everything is ok in the dist area, dist-tool-plugin has been written and run once a day to produce <a href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/" class="externalLink">“Check Source Release” and “Check Errors” reports</a>.</p></section><section>
-<h3>Add the release for next board report</h3>
-<p>After committing the 3 source-release files, visit <a href="https://reporter.apache.org/addrelease.html?maven" class="externalLink">Apache Committee Report Helper</a> to add your release data with the Full Version Name and Date of Release. (You will receive an e-mail for it as well).</p>
-<p>If you are not a PMC member, drop a line to <em><a href="mailto:private@maven.apache.org" class="externalLink">private@maven.apache.org</a></em> and ask them to do this step for you if they did not do the update while adding to release area.</p></section><section>
-<h3>Promote the release</h3>
+wagon/wagon-2.2-source-release.zip.sha512</pre></div>
+<p>You should also run 'svn rm' as needed to clear out older releases. As per <a class="externalLink" href="https://www.apache.org/legal/release-policy.html#where-do-releases-go">Apache Release Policy</a>, only the latest release on a branch should stay in the main dist areas. So long as the previous release is at least a day old, the automatic archiver will have copied it to the archive.</p>
+<p>To check that everything is ok in the dist area, dist-tool-plugin has been written and run once a day to produce <a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/">"Check Source Release" and "Check Errors" reports</a>.</p></section><section>
+<h2>Add the release for next board report</h2>
+<p>After committing the 3 source-release files, visit <a class="externalLink" href="https://reporter.apache.org/addrelease.html?maven">Apache Committee Report Helper</a> to add your release data with the Full Version Name and Date of Release. (You will receive an e-mail for it as well).</p>
+<p>If you are not a PMC member, drop a line to <i>private@maven.apache.org</i> and ask them to do this step for you if they did not do the update while adding to release area.</p></section><section>
+<h2>Promote the release</h2>
<p>Once the release is deemed fit for public consumption it can be transfered to a production repository where it will be available to all users.</p>
-<p>1 See <a href="https://www.apache.org/dev/publishing-maven-artifacts.html#promote" class="externalLink">Promoting a Repo</a> for details on promotion.</p>
-<p>1 Deploy the current website</p>
+<ol style="list-style-type: decimal">
+<li>See <a class="externalLink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#promote">Promoting a Repo</a> for details on promotion.</li>
+<li>Deploy the current website
<p>As above, deploy the web site if appropriate and update the project site for the new release: use <a href="../website/component-reference-documentation-helper.html">Component Reference Documentation Helper</a> to generate commands or see <a href="../website/deploy-component-reference-documentation.html#Publishing_versioned_component_reference_documentation">Publishing versioned component reference documentation</a> for explanations. Note that not all projects follow these conventions exactly.</p>
-<p>In case there's an overview table with version (e.g. <a href="/plugins/index.html">plugins</a> and <a href="/shared/index.html">shared</a>) you can directly edit it on the github page.</p>
-<p>1 Update the version tracking in JIRA</p>
-<p>In the relevant project, go to Administration, then Versions. Mark the <code>Y.Z</code> version as ‘released’. Create version <code>Y.Z+1</code>, if that hasn't already been done. You may also archive any deprecated releases (milestones or alphas) at this time.</p>
-<p>Note: Currently this requires to be in the maven-pmc group. So, if you don't see the Administration option in JIRA, kindly ask <em><a href="mailto:private@maven.apache.org" class="externalLink">private@maven.apache.org</a></em> to do this step for you.</p>
-<p>1 Wait for everything to sync</p>
-<p>a Sync to <a href="https://repo.maven.apache.org/maven2/org/apache/maven/" class="externalLink">Maven Central</a></p>
-
-<div class="source"><pre class="prettyprint linenums"><code>The sync into central staging from repository.apache.org occurs every 4 hours. There is a separate hourly schedule that runs which pushes from staging to the other central machines, and then updates the indexes.
-</code></pre></div>
-<p>a Sync to Maven Website</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>If the project you are releasing doesn't yet use svnpubsub for site deployment, the deployment of the Maven website will [take an hour or so to sync](https://www.apache.org/dev/release-publishing.html#sync-delay).
-</code></pre></div>
-<p>1 Create an announcement.</p>
+<p>In case there's an overview table with version (e.g. <a href="/plugins/index.html">plugins</a> and <a href="/shared/index.html">shared</a>) you can directly edit it on the github page.</p></li>
+<li>Update the version tracking in JIRA
+<p>In the relevant project, go to Administration, then Versions. Mark the <code>Y.Z</code> version as 'released'. Create version <code>Y.Z+1</code>, if that hasn't already been done. You may also archive any deprecated releases (milestones or alphas) at this time.</p>
+<p>Note: Currently this requires to be in the maven-pmc group. So, if you don't see the Administration option in JIRA, kindly ask <i>private@maven.apache.org</i> to do this step for you.</p></li>
+<li>Wait for everything to sync
+<ol style="list-style-type: lower-alpha">
+<li>Sync to <a class="externalLink" href="https://repo.maven.apache.org/maven2/org/apache/maven/">Maven Central</a>
+<p>The sync into central staging from repository.apache.org occurs every 4 hours. There is a separate hourly schedule that runs which pushes from staging to the other central machines, and then updates the indexes.</p></li>
+<li>Sync to Maven Website
+<p>If the project you are releasing doesn't yet use svnpubsub for site deployment, the deployment of the Maven website will <a class="externalLink" href="https://www.apache.org/dev/release-publishing.html#sync-delay">take an hour or so to sync</a>.</p></li></ol></li>
+<li>Create an announcement.
<p>Following instructions are done for plugins: if you are releasing anything else than a plugin, you should adapt email content to match what you are releasing.</p>
-<p><strong>Note:</strong> You must send this email from your apache email account, e.g. <a href="mailto:YOUR_APACHE_USERNAME@apache.org" class="externalLink">YOUR_APACHE_USERNAME@apache.org</a> otherwise the email to <code>announce@maven.apache.org</code> will bounce.</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>From: YOUR_APACHE_USERNAME@apache.org
+<p><b>Note:</b> You must send this email from your apache email account, e.g. YOUR_APACHE_USERNAME@apache.org otherwise the email to <code>announce@maven.apache.org</code> will bounce.</p>
+<div>
+<pre>From: YOUR_APACHE_USERNAME@apache.org
To: announce@maven.apache.org, users@maven.apache.org
Cc: dev@maven.apache.org
Subject: [ANN] Apache Maven XXX Plugin Y.Z Released
@@ -358,11 +314,10 @@ Release Notes - Maven XXX Plugin - Versi
Enjoy,
-The Apache Maven team
-
-</code></pre></div>
-<p>1 If releasing the Apache Parent POM, notify <code>release-discuss@apache.org</code>: Several projects follow this list, and should be made aware of changes to the common parent. This might also be a step to take if other shared resources are released, or if plugin releases are of particular interest to that group.</p>
-<p>If releasing Maven Core, notify <code>announce@apache.org</code></p>
-<p>1 Celebrate :o)</p></section></section></section>
+</pre></div></li>
+<li>If releasing the Apache Parent POM, notify <code>release-discuss@apache.org</code>: Several projects follow this list, and should be made aware of changes to the common parent. This might also be a step to take if other shared resources are released, or if plugin releases are of particular interest to that group.
+<p>If releasing Maven Core, notify <code>announce@apache.org</code></p></li>
+<li>Celebrate :o)</li></ol></section></section>
</main>
</div>
</div>
Modified: maven/website/content/developers/release/parent-pom-release.html
==============================================================================
--- maven/website/content/developers/release/parent-pom-release.html (original)
+++ maven/website/content/developers/release/parent-pom-release.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/developers/release/parent-pom-release.md at 2023-02-18
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/developers/release/parent-pom-release.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="Hervé Boutemy, Dennis Lundberg" />
+ <meta name="author" content="Hervé Boutemy
+Dennis Lundberg" />
<meta name="date" content="2013-12-07" />
<title>Maven – Releasing A Parent POM</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 ">Releasing A Parent POM <a href="https://github.com/apache/maven-site/tree/master/content/markdown/developers/release/parent-pom-release.md"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li class="active ">Releasing A Parent POM <a href="https://github.com/apache/maven-site/tree/master/content/apt/developers/release/parent-pom-release.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>
@@ -139,36 +140,16 @@
</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>Releasing A Parent POM</h2>
+<section>
+<h1>Releasing A Parent POM</h1>
<p>Releasing a Parent POM is much the same as any other Maven project. The following guide walks through most of the steps:</p>
<ul>
-
-<li><a href="./maven-project-release-procedure.html">Maven Project Common Release procedure</a></li>
-</ul>
+<li><a href="./maven-project-release-procedure.html"> Maven Project Common Release procedure</a></li></ul>
<p>Note that Parent POMs have particular conventions for managing and deploying the documentation.</p><section>
-<h3>Rationale</h3>
+<h2>Rationale</h2>
<p>To be able to publish a documentation for the parent POM without affecting released <code>pom.xml</code> and <code>site.xml</code>, parent POM projects have a specific structure, with the addition of <code>site-pom.xml</code> and <code>src/site-docs</code> to provide <code>mvn -f site-pom.xml site</code> with useful documentation content:</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>|-- pom.xml
+<div>
+<pre>|-- pom.xml
|-- site-pom.xml
`-- src
|-- site
@@ -176,25 +157,24 @@ under the License.
`-- site-docs
|-- apt
| `-- index.apt
- `-- site.xml
-</code></pre></div>
+ `-- site.xml</pre></div>
<p>And the <code>index.apt</code> page not only contains instructions about the content of the parent POM, but it maintains a history of POM releases links and diffs.</p>
<p>Each specific step is done to maintain <code>site-pom.xml</code> and <code>index.apt</code> in sync with the release being released.</p></section><section>
-<h3>Stage the release</h3>
+<h2>Stage the release</h2>
<p>Before staging the release with usual procedure, you need to update <code>site-pom.xml</code> and <code>index.apt</code> to take the future release into account:</p>
-<p>1 update <code>site-pom.xml</code> parent POM version to match the version being released,</p>
-<p>1 update <code>src/site-docs/index.apt.vm</code>: add a line in the history of <code>pom.xml</code> for the version being released, referring to the future git release tag and date.</p>
+<ol style="list-style-type: decimal">
+<li>update <code>site-pom.xml</code> parent POM version to match the version being released,</li>
+<li>update <code>src/site-docs/index.apt.vm</code>: add a line in the history of <code>pom.xml</code> for the version being released, referring to the future git release tag and date.</li></ol>
<p>Once these modifications are done, you can follow <a href="../website/deploy-component-reference-documentation.html">standard component documentation staging steps</a>, taking care to use the <code>site-pom.xml</code> POM, with <code>mvn -f site-pom.xml ...</code> command, each time the parent POM's site is generated or published.</p>
<p>Then the only difference is with commands to stage the site:</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>cd target/checkout
+<div>
+<pre>cd target/checkout
mvn -f site-pom.xml site
-mvn -f site-pom.xml scm-publish:publish-scm
-</code></pre></div></section><section>
-<h3>Call the vote</h3>
+mvn -f site-pom.xml scm-publish:publish-scm</pre></div></section><section>
+<h2>Call the vote</h2>
<p>In the vote, instead of providing links to JIRA, the parent POMs should include a link to the Git changes since the last release:</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>...
+<div>
+<pre>...
Hi,
Changes since the last release:
@@ -205,8 +185,7 @@ or for Maven Projects Parent POM:
https://github.com/apache/maven-parent/compare/maven-parent-<VERSION-OF-PREVIOUS-RELEASE>...maven-parent-<VERSION-OF-CURRENT-RELEASE>
Staging repo:
-...
-</code></pre></div></section></section></section>
+...</pre></div></section></section>
</main>
</div>
</div>