You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by th...@apache.org on 2014/08/05 08:19:11 UTC
svn commit: r1615866 - /jackrabbit/site/live/JCR/creating-releases.html
Author: thomasm
Date: Tue Aug 5 06:19:10 2014
New Revision: 1615866
URL: http://svn.apache.org/r1615866
Log:
Add line breaks to simplify editing; fix links
Modified:
jackrabbit/site/live/JCR/creating-releases.html
Modified: jackrabbit/site/live/JCR/creating-releases.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/JCR/creating-releases.html?rev=1615866&r1=1615865&r2=1615866&view=diff
==============================================================================
--- jackrabbit/site/live/JCR/creating-releases.html (original)
+++ jackrabbit/site/live/JCR/creating-releases.html Tue Aug 5 06:19:10 2014
@@ -82,31 +82,45 @@
</DIV>
<DIV id="content">
<H1>Creating Releases</H1>
- <P>This is a how to document for creating Apache Jackrabbit releases. It documents the current release process and needs to be updated as we move forward.</P>
+ <P>This is a how to document for creating Apache Jackrabbit releases.
+ It documents the current release process and needs to be updated as we move forward.</P>
<H2><A name="CreatingReleases-Releaseplanning"></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 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.</P>
+<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 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.</P>
-<P>If you're not a committer, you can send a message to the mailing list asking for a new release to be made. Including the list of specific fixes you need and a short rationale of why you need the release.</P>
+<P>If you're not a committer, you can send a message to the mailing list asking for a new release to be made.
+Including the list of specific fixes you need and a short rationale of why you need the release.</P>
<H2><A name="CreatingReleases-Prerequisitesforreleasemanagers"></A>Prerequisites for release managers</H2>
-<P>You need to be a Jackrabbit committer to prepare and perform a release, but anyone is welcome to help test the release candidates and comment on the release plans.</P>
+<P>You need to be a Jackrabbit committer to prepare and perform a release,
+but anyone is welcome to help test the release candidates and comment on the release plans.</P>
-<P>You should have a code signing key that is included in the Jackrabbit KEYS file. See <A href="#CreatingReleases-AppendixA">Appendix A</A> at the end of this page for more details.</P>
+<P>You should have a code signing key that is included in the Jackrabbit KEYS file. See
+<A href="#CreatingReleases-AppendixA">Appendix A</A> at the end of this page for more details.</P>
-<P>You also need to tell Maven your Subversion credentials needed for deploying artifacts to the Nexus server at <A href="https://repository.apache.org/" class="external-link">https://repository.apache.org/</A>. See <BR>
+<P>You also need to tell Maven your Subversion credentials needed for deploying artifacts to the Nexus server at
+<A href="https://repository.apache.org/" class="external-link">https://repository.apache.org/</A>. See <BR>
<A href="#CreatingReleases-AppendixB">Appendix B</A> for the required settings.</P>
<H2><A name="CreatingReleases-Releasemanagementtasks"></A>Release management tasks</H2>
<OL>
<LI>Make sure that an appropriate version for the release is entered in Jira and that all the related issues have been resolved.</LI>
- <LI>Create a <TT>RELEASE-NOTES.txt</TT> file in the root folder of the project to be released. If such a file already exists, update it for the release. When done, commit the file. See <A href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=10591&version=12319480" class="external-link">previous release notes</A> for examples of what to include. The release note report in Jira is a useful source of required information.</LI>
+ <LI>Create a <TT>RELEASE-NOTES.txt</TT> file in the root folder of the project to be released.
+ If such a file already exists, update it for the release. When done, commit the file.
+ See <A href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=10591&version=12319480" class="external-link">previous release notes</A>
+ for examples of what to include.
+ The release note report in Jira is a useful source of required information.</LI>
<LI>Build and deploy the release artifacts with Maven. See <A href="#CreatingReleases-ReleaseArtifacts">below</A> for the exact steps.</LI>
<LI>Close the <A href="https://repository.apache.org/index.html#stagingRepositories" class="external-link">staged repository</A> on repository.apache.org.</LI>
- <LI>Upload the artifacts to <A href="https://dist.apache.org/repos/dist/dev/jackrabbit/" class="external-link">https://dist.apache.org/repos/dist/dev/jackrabbit/</A> (instructions at the end of the build)
+ <LI>Upload the artifacts to
+ <A href="https://dist.apache.org/repos/dist/dev/jackrabbit/" class="external-link">https://dist.apache.org/repos/dist/dev/jackrabbit/</A>
+ (instructions at the end of the build)
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
cd /path/to/jackrabbit-dev
@@ -120,7 +134,9 @@
<LI>If the vote is successful
<OL>
<LI>close the vote by publishing the results</LI>
- <LI>copy the release candidate from dev/jackrabbit to release/jackrabbit in <A href="https://dist.apche.org/repos/dist/" class="external-link">https://dist.apche.org/repos/dist/</A>, and delete any older releases from the same branch (they're automatically archived),
+ <LI>copy the release candidate from dev/jackrabbit to release/jackrabbit in
+ <A href="https://dist.apache.org/repos/dist/" class="external-link">https://dist.apache.org/repos/dist/</A>,
+ and delete any older releases from the same branch (they're automatically archived),
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
svn move -m <SPAN class="code-quote">"Apache Jackrabbit $version"</SPAN> \
@@ -128,24 +144,43 @@
</SPAN> https:<SPAN class="code-comment">//dist.apache.org/repos/dist/release/jackrabbit/$version
</SPAN> </PRE>
</DIV></DIV></LI>
- <LI>release the <A href="https://repository.apache.org/index.html#stagingRepositories" class="external-link">staged repository</A> for synchronization to Maven central.</LI>
- <LI>mark the version as released in Jira: <A href="https://issues.apache.org/jira/browse/JCR" class="external-link">Jira Project Home</A> -> Project Summary -> Administer Project. Under Versions, click <More>. You'll see all the defined project versions. From the settings menu, choose 'Release' on the version.</LI>
- <LI>close all the issues included in the release: <A href="https://issues.apache.org/jira/browse/JCR" class="external-link">Jira Project Home</A> -> Change Log -> Choose the released version. From the issue list you have the option to bulk update all of the included issues. Just 'Transition Issues' from 'Resolved' to 'Closed' and you are done!</LI>
+ <LI>release the
+ <A href="https://repository.apache.org/index.html#stagingRepositories" class="external-link">staged repository</A>
+ for synchronization to Maven central.</LI>
+ <LI>mark the version as released in Jira:
+ <A href="https://issues.apache.org/jira/browse/JCR" class="external-link">Jira Project Home</A> -> Project Summary -> Administer Project.
+ Under Versions, click <More>. You'll see all the defined project versions.
+ From the settings menu, choose 'Release' on the version.</LI>
+ <LI>close all the issues included in the release:
+ <A href="https://issues.apache.org/jira/browse/JCR" class="external-link">Jira Project Home</A> -> Change Log -> Choose the released version.
+ From the issue list you have the option to bulk update all of the included issues.
+ Just 'Transition Issues' from 'Resolved' to 'Closed' and you are done!</LI>
</OL>
</LI>
- <LI><A href="http://wiki.apache.org/jackrabbit/JackrabbitWebsite" class="external-link">Update the Jackrabbit web site</A> to point to the new release.</LI>
- <LI>Send the release announcement once the web site and download mirrors have been synced.</LI>
+ <LI><A href="http://wiki.apache.org/jackrabbit/JackrabbitWebsite" class="external-link">
+ Update the Jackrabbit web site</A> to point to the new release.</LI>
+ <LI>
+ Send the release announcement once the web site and download mirrors have been synced.
+ Please note the announce mails needs to be sent from an @apache.org address.
+ </LI>
</OL>
<P><A name="CreatingReleases-ReleaseArtifacts"></A></P>
<H2><A name="CreatingReleases-Stepstobuildthereleaseartifacts"></A>Steps to build the release artifacts </H2>
-<P>The release is built using the Maven release plugin. See the <A href="http://maven.apache.org/developers/release/releasing.html" class="external-link">Releasing a Maven project</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="#CreatingReleases-AppendixB">Appendix B</A> for the details.</P>
+<P>The release is built using the Maven release plugin. See the
+<A href="http://maven.apache.org/developers/release/releasing.html" class="external-link">Releasing a Maven project</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="#CreatingReleases-AppendixB">Appendix B</A> for the details.</P>
<OL>
<LI>Execute <TT>mvn release:prepare</TT>. This will update the POM files and tag the release in svn.</LI>
- <LI>Execute <TT>mvn release:perform</TT>. 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>Execute <TT>mvn release:perform</TT>.
+ 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>
</OL>
@@ -165,8 +200,11 @@
<P>Follow these instructions to generate your code signing key and to add it to the Jackrabbit KEYS file.</P>
<OL>
- <LI><A href="http://www.apache.org/dev/release-signing.html#generate" class="external-link">Generate a code signing key</A> using your @apache.org address as the email and "CODE SIGNING KEY" as the comment.</LI>
- <LI>The Jackrabbit KEYS file is managed in <A href="https://svn.apache.org/repos/asf/jackrabbit/dist/KEYS" class="external-link">https://svn.apache.org/repos/asf/jackrabbit/dist/KEYS</A>. To modify the file, first checkout the dist directory:
+ <LI><A href="http://www.apache.org/dev/release-signing.html#generate" class="external-link">Generate a code signing key</A>
+ using your @apache.org address as the email and "CODE SIGNING KEY" as the comment.</LI>
+ <LI>The Jackrabbit KEYS file is managed in
+ <A href="https://svn.apache.org/repos/asf/jackrabbit/dist/KEYS" class="external-link">https://svn.apache.org/repos/asf/jackrabbit/dist/KEYS</A>.
+ To modify the file, first checkout the dist directory:
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-none">
svn checkout https://svn.apache.org/repos/asf/jackrabbit/dist
@@ -179,11 +217,14 @@ svn checkout https://svn.apache.org/repo
umask 002; svn update /www/www.apache.org/dist/jackrabbit
</PRE>
</DIV></DIV></LI>
- <LI>You are <B>DONE</B>, but to see the changes on <A href="http://www.apache.org/dist/jackrabbit/KEYS" class="external-link">http://www.apache.org/dist/jackrabbit/KEYS</A> you must wait 2 hours</LI>
+ <LI>You are <B>DONE</B>, but to see the changes on
+ <A href="http://www.apache.org/dist/jackrabbit/KEYS" class="external-link">http://www.apache.org/dist/jackrabbit/KEYS</A> you must wait 2 hours</LI>
</OL>
-<P>You should get your key <A href="http://www.apache.org/dev/release-signing.html#apache-wot" class="external-link">linked to the Apache web of trust</A>. Once other people have signed your key, you can update the KEYS file with the signatures you've received.</P>
+<P>You should get your key
+<A href="http://www.apache.org/dev/release-signing.html#apache-wot" class="external-link">
+linked to the Apache web of trust</A>. Once other people have signed your key, you can update the KEYS file with the signatures you've received.</P>
<P><A name="CreatingReleases-AppendixB"></A></P>
<H2><A name="CreatingReleases-AppendixB%3AMavensettings"></A>Appendix B: Maven settings </H2>
@@ -235,7 +276,6 @@ umask 002; svn update /www/www.apache.or
<P>
© 2004-2010 The Apache Software Foundation.
- <A href="http://jackrabbit.apache.org/privacy-policy.html">Privacy Policy</A> -
- [<A href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=80946">edit this page</A>]
<BR>
Apache Jackrabbit, Jackrabbit, Apache, the Apache feather logo, and the Apache
Jackrabbit project logo are trademarks of The Apache Software Foundation.