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 2025/06/21 09:34:44 UTC
svn commit: r1926616 - /maven/website/content/developers/release/maven-project-release-procedure.html
Author: svn-site-role
Date: Sat Jun 21 09:34:43 2025
New Revision: 1926616
Log:
Site checkin for project Apache Maven Site
Modified:
maven/website/content/developers/release/maven-project-release-procedure.html
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 Jun 21 09:34:43 2025
@@ -155,9 +155,8 @@
<p>Be sure that:</p>
<ul>
<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>you have JDK installed and on your shell's path to build Maven 3.9.0+. Details about minimum JDK version to build 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>
<li>check <a href="./pmc-gpg-keys.html"> your Public GPG key</a> which will be used for release.</li></ul></section><section><a id="Before_you_begin"></a>
<h2>Before you begin</h2>
@@ -170,19 +169,23 @@
<h3>Consider updating the project dependencies</h3>
<p>Generally it is a good that project use tha latest available versions of used dependencies.</p></section></section><section><a id="Prepare_release_notes"></a>
<h2>Prepare release notes</h2>
+<p>We maintain release notes at <b>Github</b>. We use <b>release-drafter</b> to help prepare release notes.</p>
<ul>
-<li>check all commits since latest release, all mentioned issue should be connected with release notes</li>
-<li>all issues should be <b>assigned</b> to responsible person, which fixed or merged fix</li>
-<li>all issues should be fixed and <b>CLOSED</b></li>
-<li>check existing issues with <b>Blocker</b> priority, consider to fix it or change priority if reasonable</li></ul><section><a id="Check_release_notes_at_GitHub"></a>
-<h3>Check release notes at GitHub</h3>
-<p>If a component has a history of release notes at <b>GitHub</b>, we should to continue maintain it in order to avoid user confusing.</p>
-<p>We can maintain release notes at <b>GitHub</b>, by one of:</p>
+<li>check all commits since the latest release. All mentioned issues should be included in release notes</li>
+<li>all issues and pull requests should be <b>assigned</b> to person who merged the PR</li>
+<li>all issues assigned to the release should be fixed and <b>CLOSED</b></li>
+<li>all issues and pull requests should be assigned to milestone</li>
+<li>check existing issues with <i>Blocker</i> priority. Consider fixing or changing the priority</li>
+<li>you should check whether groups of reported pull requests contain the correct items</li>
+<li>you can adjust labels in pull requests to assign them</li>
+<li>you can add the <b>skip-changelog</b> label to a pull request to exclude it from the release notes</li></ul>
+<p>Execute the <b>Release Drafter</b> workflow on <b>GitHub</b> to regenerate draft of release notes if labels were changed.</p>
+<p>You should <code>disable</code> <b>Release Drafter</b> workflow on <b>GitHub</b> to avoid adding new items to the release notes after the vote starts and before the release notes are published. Follow <a class="externalLink" href="https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow">Disabling and enabling a workflow</a></p></section><section><a id="Update_milestone_in_GitHub"></a>
+<h2>Update milestone in GitHub</h2>
<ul>
-<li>use release-drafter to help prepare release notes - in such case all PRs should a proper label</li>
-<li>copy paste release notes from GitHub</li></ul>
-<p>Draft of release notes at <b>GitHub</b> can be prepared before publishing.</p>
-<p>You can disable <b>Release Drafter</b> workflow on <b>GitHub</b> to avoid adding new items to release notes after vote starts but before publishing release notes.</p></section></section><section><a id="Make_sure_that_site_compilation_works"></a>
+<li>close released milestone and open a new one for the next version</li>
+<li>pull requests merged during votes should be assigned to next milestone</li>
+<li>Note: For projects which maintain multiple versions, add the branch name (<code>branch: branch-name</code>) to the milestone description.</li></ul></section><section><a id="Make_sure_that_site_compilation_works"></a>
<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>
<pre>mvn -Preporting site site:stage</pre></section><section><a id="Stage_the_Release"></a>
@@ -199,7 +202,7 @@ Subject: [VOTE] Release Apache Maven XXX
Hi,
We solved N issues:
-https://github.com/apache/maven-compiler-plugin/issues?q=is%3Aissue%20state%3Aopen%20milestone%3A3.14.1
+https://github.com/apache/<repository-name>/issues?q=is%3Aclosed%20milestone%3A<version>
Changes since the last release:
https://github.com/apache/<repository-name>/compare/<last-tag>...<current-tag>
@@ -222,18 +225,7 @@ Vote open for at least 72 hours.
[ ] +1
[ ] +0
[ ] -1
-</pre><section><a id="GitHub_issues"></a>
-<h3>GitHub issues</h3>
-<p>To get the Github release notes link, browse to the GitHub repository, select the <i>Releases</i> link, pick a version, and use the link to <i>Release Notes</i> that is next to the version being released.</p></section><section><a id="GitHub_issues_1"></a>
-<h3>GitHub issues</h3>
-<p>We link to the <i>GitHub milestone</i> for issues resolved in the release, and link to <i>GitHub issues</i> for issues that are still open:</p>
-<pre>
-We solved N issues:
-https://github.com/apache/<repository-name>/milestone/<milestone-id>?closed=1
-
-There are still a couple of issues left:
-https://github.com/apache/<repository-name>/issues
-</pre></section></section><section><a id="Check_the_vote_results"></a>
+</pre></section><section><a id="Check_the_vote_results"></a>
<h2>Check the vote results</h2>
<p>The "vote is open for at least 72 hours" means that you need to wait <i>at least</i> 72 hours before proceeding. This gives others time to test your staged release and check that everything is good, with the help of our <a href="/guides/development/guide-testing-releases.html">Guide to testing staged releases</a>.</p>
<p>If after that period you have not received enough +1 votes to reach the quorum, this doesn't mean the vote failed: it just takes a bit longer.</p>
@@ -301,19 +293,11 @@ wagon/wagon-2.2-source-release.zip.sha51
<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>, <a href="/shared/index.html">shared</a>, <a href="/skins/index.html">skins</a>), update the table: you can directly edit it on the github page.</p>
<p>For plugins and shared, you can also run <code>mvn -Pupdate package</code> of the site, then review and commit proposed <code>index.apt</code> updates.</p></li>
-<li>Update the version tracking
-<ol style="list-style-type: lower-alpha;">
-<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>Update milestone in GitHub
-<p>Close released milestone and open new one for next version.</p>
-<p>Note: For projects, which maintain multiple versions, add the branch name (<code>branch: branch-name</code>) to the milestone description.</p></li>
<li>Publish release notes draft in GitHub
<p>Check or adapt content to match what you are releasing.</p>
<p>Check version and tag fulfilled in release notes - if not match with published release adjust it.</p>
<p>Note: PR merged after release but before publishing can add next items to release notes draft.</p>
-<p>Enable <b>Release Drafter</b> workflow on <b>GitHub</b> if was disabled during vote.</p></li></ol></li>
+<p>Enable <b>Release Drafter</b> workflow on <b>GitHub</b> if was disabled during vote.</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>
@@ -356,7 +340,6 @@ Enjoy,
</pre></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>Publish release notes at <b>GitHub</b> if it is maintained.</li>
<li>Celebrate :o)</li></ol></section><section><a id="Check_Consistency"></a>
<h2>Check Consistency</h2>
<p>You can also check if you (or any previous release manager) did not miss any step by looking at the <a class="externalLink" href="https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-dist-tool/job/master/site/dist-tool-check-errors.html"> Dist Tool Check Errors report</a>.</p></section></section> </main>