You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by sv...@apache.org on 2025/08/11 14:44:18 UTC
svn commit: r1927751 - jackrabbit/site/live/jcr
Author: svn-site-role
Date: Mon Aug 11 14:44:17 2025
New Revision: 1927751
Log:
@trivial: Site checkin for project Apache Jackrabbit Site-1.0-SNAPSHOT
Modified:
jackrabbit/site/live/jcr/creating-releases.html
Modified: jackrabbit/site/live/jcr/creating-releases.html
==============================================================================
--- jackrabbit/site/live/jcr/creating-releases.html Mon Aug 11 12:33:04 2025 (r1927750)
+++ jackrabbit/site/live/jcr/creating-releases.html Mon Aug 11 14:44:17 2025 (r1927751)
@@ -193,8 +193,10 @@ forward.</p>
<h2><a name="Release_planning"></a>Release planning</h2>
<p>Jackrabbit releases are created based on user demand and the availability
of fixes and other requested changes. Any committer can declare their plan
-to cut a release by sending a “Apache Jackrabbit x.y.z release plan”
-message to the dev@ list. The plan should refer to Jira for the list of
+to cut a release by sending a “Apache Jackrabbit (Oak) x.y.z Release Plan”
+message to the Jackrabbit Developers Mailing List - <a class="externalLink" href="mailto:dev@jackrabbit.apache.org">dev@jackrabbit.apache.org</a> or
+Oak Developers Mailing List - <a class="externalLink" href="mailto:dev@jackrabbit.apache.org">oak-dev@jackrabbit.apache.org</a>.
+The plan should refer to Jira for the list of
fixes to be included in the release and give a rough estimate of the
release schedule. It's OK to revise the plan if needed. Optimally, link to
the candidate release notes.</p>
@@ -209,8 +211,19 @@ release plans.</p>
file. See <a href="#Appendix_A:_Create_and_add_your_key_to_the_Jackrabbit_KEYS_file">Appendix A</a> at the end of this page for more details.</p>
<p>You also need to tell Maven your Apache LDAP credentials needed for
deploying artifacts to the Nexus server at <a class="externalLink" href="https://repository.apache.org/">https://repository.apache.org/</a>.
-See <a href="#Appendix_B:_Maven_settings">Appendix B</a> for the required settings.</p></section><section>
-<h2><a name="Release_management_tasks"></a>Release management tasks</h2><section>
+See <a href="#Appendix_B:_Maven_settings">Appendix B</a> for the required settings.</p>
+<p>You need write access to the following repositories:</p>
+<ol style="list-style-type: decimal">
+
+<li>Git: source code - either <a class="externalLink" href="https://gitbox.apache.org/repos/asf/jackrabbit.git">https://gitbox.apache.org/repos/asf/jackrabbit.git</a> or <a class="externalLink" href="https://gitbox.apache.org/repos/asf/jackrabbit-oak.git">https://gitbox.apache.org/repos/asf/jackrabbit-oak.git</a></li>
+<li>Git: site - <a class="externalLink" href="https://gitbox.apache.org/repos/asf/jackrabbit-site.git">https://gitbox.apache.org/repos/asf/jackrabbit-site.git</a>)</li>
+<li>Subversion: test / release: <a class="externalLink" href="https://dist.apache.org/repos/dist/dev/jackrabbit">https://dist.apache.org/repos/dist/dev/jackrabbit</a> and <a class="externalLink" href="https://dist.apache.org/repos/dist/release/jackrabbit">https://dist.apache.org/repos/dist/release/jackrabbit</a></li>
+</ol>
+<p>The release announcement needs to be sent from your ASF mail account. It is recommended but not necessary to use that mail account
+for all other communication as well.</p></section><section>
+<h2><a name="Release_management_tasks"></a>Release management tasks</h2>
+<p>It is useful but not required to keep track of all release tasks in a Jira ticket.
+See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-11840">https://issues.apache.org/jira/browse/OAK-11840</a> for an example.</p><section>
<h3><a name="Part_I:_up_to_the_release_vote"></a>Part I: up to the release vote</h3>
<ol style="list-style-type: decimal">
@@ -290,12 +303,6 @@ Guava (see <a class="externalLink" href=
</li>
<li>
-<p>For Oak releases that support a range of Guava versions (right now 1.22), make sure the system builds and tests with the highest version in the range
-as well (see <code>guava.osgi.import</code> property in <code>oak-parent/pom.xml</code>) - right now that is 20.0.
-Use <code>-Pguava-latest</code> for the tests. (This step can likely be removed soon, as Oak 1.22 will stay on the old release of Guava due to compatibility issues)</p>
-</li>
-<li>
-
<p>When doing “stable” release (even-numbered), check that we do not have
dependencies to unstable releases. In particular, stable releases of Oak
should not reference unstable Jackrabbit releases (if this is the case,
@@ -346,7 +353,7 @@ svn commit -m "Apache Jackrabbit Oa
</li>
<li>
-<p>Find the vote template (<code>./target/checkout/target/vote.txt</code>) generated by the Maven build and follow the instructions to verify the build yourself</p>
+<p>Find the “vote” template (<code>./target/checkout/target/vote.txt</code>) generated by the Maven build and follow the instructions to verify the build yourself</p>
</li>
<li>
@@ -356,6 +363,10 @@ svn commit -m "Apache Jackrabbit Oa
<p>Wait 72 hours (we usually allow three business days, so be careful when a weekend is ahead)</p>
</li>
+<li>
+
+<p>Keep the “announcement” template (<code>./target/checkout/target/announcement.txt</code>) for later.</p>
+</li>
</ol></section><section>
<h3><a name="Part_II:_after_the_release_vote"></a>Part II: after the release vote</h3>
<p>If the vote fails (easy case first):</p>
@@ -443,15 +454,15 @@ In case you are using a mailbox other th
<h2><a name="Steps_to_build_the_release_artifacts"></a>Steps to build the release artifacts</h2>
<p>The release is built using the Maven release plugin (if your platform is Windows with Cygwin, see <a href="#Appendix_C:_Cygwin">Appendix C</a>). See the <a class="externalLink" href="https://maven.apache.org/developers/release/maven-project-release-procedure.html">Performing a Maven Project Release</a> guide for more details. Make sure you have added the pgp key information in you maven settings file, especially if you have more than one key installed locally. See <a href="#b">Appendix B</a> for the details.</p>
<p>In case you don't feel comfortable to keep the passwords in the file <code>~/.m2/settings.xml</code> forever, you need to set it now temporarily.</p>
-<p>There have been some problems with certain combinations of Java and Maven versions. A known combinations where releasing was successful is Java 7 with Maven 3.2.2. In case you get an exception “Proxy Error” in the <code>release:perform</code>, see the <a class="externalLink" href="http://status.apache.org/">Apache Services Status Page</a>, however it has been reported that the status page is not always accurate. In case you get an error with respect to API incompatibilities, try with an older Maven version or enforce use of a newer release plugin, such as with <code>mvn org.apache.maven.plugins:maven-release-plugin:2.5.3:prepare</code>.</p>
<p>Note that preparing the release requires a tagging operation in the source
repository. Make sure upfront that non-interactive commits work
(like <code>svn commit -m 'commit message'</code> or <code>git push</code>) without prompting for credentials, otherwise
the tagging step will fail.</p>
<ol style="list-style-type: decimal">
-<li>Execute mvn <code>release:prepare</code>. This will update the POM files and tag the release in svn (see <a href="#Appendix_F:_Version_Numbers">Appendix F</a> for how version numbers change).</li>
+<li>Execute mvn <code>release:prepare</code>. This will update the POM files and tag the release in Git (see <a href="#Appendix_F:_Version_Numbers">Appendix F</a> for how version numbers change).</li>
<li>Execute mvn <code>release:perform</code>. This will build the tagged release and deploy the artifacts to a staging repository on repository.apache.org. The non-Maven release artifacts are automatically deployed to your home directory on people.apache.org. You only need to add the keyname if you have multiple keys and the code signing keys is not your default key.</li>
+<li>Capture the URL of the stanging repository; it can be added to the Vote email.</li>
</ol>
<p>After this is done, you can remove the passwords from the file <code>~/.m2/settings.xml</code> if you don't want to keep it there.</p><section><section>
<h4><a name="Version_Numbers"></a>Version Numbers</h4>
@@ -614,7 +625,7 @@ stable release was “2.18.3”
<p>Stable releases are cut from a branch, where the branch name is based on
major and minor version number (here: “2.18”). Unstable releases are built from
trunk.</p>
-<p>Creating a new major release implies creating a new branch (next would be “2.20”), see
+<p>Creating a new major release implies creating a new branch (next would be “2.24”), see
<a href="#Appendix_D:_Branching">Appendix D</a>.</p>
<p>For creating releases, the default version numbers proposed by <code>mvn release:prepare</code>
work out of the box.</p>