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/09/01 14:17:52 UTC

svn commit: r1621755 - /jackrabbit/site/live/JCR/creating-releases.html

Author: thomasm
Date: Mon Sep  1 12:17:52 2014
New Revision: 1621755

URL: http://svn.apache.org/r1621755
Log:
Update release docs

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=1621755&r1=1621754&r2=1621755&view=diff
==============================================================================
--- jackrabbit/site/live/JCR/creating-releases.html (original)
+++ jackrabbit/site/live/JCR/creating-releases.html Mon Sep  1 12:17:52 2014
@@ -188,7 +188,8 @@ forever, you need to set it now temporar
 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 href="http://status.apache.org/">Apache Services Status Page</a>.
+<a href="http://status.apache.org/">Apache Services Status Page</a>,
+however it has been reported that the status page is not always accurate.
 </p>
 
 <OL>
@@ -249,51 +250,59 @@ svn commit -m "Add code signing key" KEY
 
 <P>You can (but don't need to) 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>
+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>
 
+<p>
+You need to change the <code>~/.m2/settings.xml</code> file as follows.
+PGP key id: this is the second part of your key in the KEYS file. 
+For example, this is "F07CA77B" if the first line of your key in the KEYS file is
+"pub   4096R/F07CA77B 2014-07-31".
+In case you are not comfortable to keep passwords and key passphrases in human readable
+files, you can add them just before doing the release, and remove them just after the release.
+Instead of using the "gpg.passphrase" tag, you can try using 
+&lt;gpg.executable&gt;gpg2&lt;/gpg.executable&gt; (this should prompt you for the passphrase).
+For the server svn passwords, you could use the 
+<a href="http://maven.apache.org/guides/mini/guide-encryption.html">Maven password encryption</a>.
+</p>
+
 <DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
-<PRE class="code-xml">
-<SPAN class="code-tag">&lt;settings&gt;</SPAN>
+
+<!-- please note the xmp tag is deprecated, but works in almost all browsers,
+and is the only way to avoid having to escape all < and > tags -->
+<pre class="code-xml"><xmp><settings>
 ...
-  <SPAN class="code-tag">&lt;servers&gt;</SPAN>
-    <SPAN class="code-tag"><SPAN class="code-comment">&lt;!-- To deploy a Jackrabbit snapshot --&gt;</SPAN></SPAN>
-    <SPAN class="code-tag">&lt;server&gt;</SPAN>
-      <SPAN class="code-tag">&lt;id&gt;</SPAN>apache.snapshots.https<SPAN class="code-tag">&lt;/id&gt;</SPAN>
-      <SPAN class="code-tag">&lt;username&gt;</SPAN> <SPAN class="code-tag"><SPAN class="code-comment">&lt;!-- YOUR APACHE SVN USERNAME --&gt;</SPAN></SPAN> <SPAN class="code-tag">&lt;/username&gt;</SPAN>
-      <SPAN class="code-tag">&lt;password&gt;</SPAN> <SPAN class="code-tag"><SPAN class="code-comment">&lt;!-- YOUR APACHE SVN PASSWORD --&gt;</SPAN></SPAN> <SPAN class="code-tag">&lt;/password&gt;</SPAN>
-    <SPAN class="code-tag">&lt;/server&gt;</SPAN>
-    <SPAN class="code-tag"><SPAN class="code-comment">&lt;!-- To stage a Jackrabbit release --&gt;</SPAN></SPAN>
-    <SPAN class="code-tag">&lt;server&gt;</SPAN>
-      <SPAN class="code-tag">&lt;id&gt;</SPAN>apache.releases.https<SPAN class="code-tag">&lt;/id&gt;</SPAN>
-      <SPAN class="code-tag">&lt;username&gt;</SPAN> <SPAN class="code-tag"><SPAN class="code-comment">&lt;!-- YOUR APACHE SVN USERNAME --&gt;</SPAN></SPAN> <SPAN class="code-tag">&lt;/username&gt;</SPAN>
-      <SPAN class="code-tag">&lt;password&gt;</SPAN> <SPAN class="code-tag"><SPAN class="code-comment">&lt;!-- YOUR APACHE SVN PASSWORD --&gt;</SPAN></SPAN> <SPAN class="code-tag">&lt;/password&gt;</SPAN>
-    <SPAN class="code-tag">&lt;/server&gt;</SPAN>
+  <profiles>
+    <profile>
+      <id>apache-release</id>
+      <properties>
+        <gpg.keyname><!-- PGP key id, see above --></gpg.keyname>
+        <gpg.passphrase><!-- PGP key passphrase --></gpg.passphrase>
+      </properties>
+    </profile>
     ...
-    <SPAN class="code-tag">&lt;profiles&gt;</SPAN>
-      <SPAN class="code-tag">&lt;profile&gt;</SPAN>
-        <SPAN class="code-tag">&lt;id&gt;</SPAN>apache-release<SPAN class="code-tag">&lt;/id&gt;</SPAN>
-        <SPAN class="code-tag">&lt;properties&gt;</SPAN>
-          <SPAN class="code-tag">&lt;gpg.keyname&gt;</SPAN><SPAN class="code-tag"><SPAN class="code-comment">&lt;!-- enough of the key id to id it --&gt;</SPAN></SPAN><SPAN class="code-tag">&lt;/gpg.keyname&gt;</SPAN>
-
-          <SPAN class="code-tag"><SPAN class="code-comment">&lt;!-- pick one of the following --&gt;</SPAN></SPAN>
-
-          <SPAN class="code-tag"><SPAN class="code-comment">&lt;!-- either you feel comfortable with the passphrase on disk --&gt;</SPAN></SPAN>
-          <SPAN class="code-tag">&lt;gpg.passphrase&gt;</SPAN><SPAN class="code-tag"><SPAN class="code-comment">&lt;!-- your passphrase for your gpg key goes here--&gt;</SPAN></SPAN><SPAN class="code-tag">&lt;/gpg.passphrase&gt;</SPAN>
-
-          <SPAN class="code-tag"><SPAN class="code-comment">&lt;!-- or you use an agent--&gt;</SPAN></SPAN>
-          <SPAN class="code-tag">&lt;gpg.useagent&gt;</SPAN>true<SPAN class="code-tag">&lt;/gpg.useagent&gt;</SPAN>
-
-        <SPAN class="code-tag">&lt;/properties&gt;</SPAN>
-      <SPAN class="code-tag">&lt;/profile&gt;</SPAN>
-      ...
-    <SPAN class="code-tag">&lt;/profiles&gt;</SPAN>
-  <SPAN class="code-tag">&lt;/servers&gt;</SPAN>
-<SPAN class="code-tag">&lt;/settings&gt;</SPAN>
-</PRE>
+  </profiles>
+  <servers>
+    <!-- To deploy a Jackrabbit snapshot -->
+    <server>
+      <id>apache.snapshots.https</id>
+      <username><!-- Apache svn user name --></username>
+      <password><!-- Apache svn password --></password>
+    </server>
+    <!-- To stage a Jackrabbit release -->
+    <server>
+      <id>apache.releases.https</id>
+      <username><!-- Apache svn user name --></username>
+      <password><!-- Apache svn password --></password>
+    </server>
+    ...
+  </servers>
+</settings></xmp></pre>
 </DIV></DIV>
+</p>
         </DIV>
         <DIV id="end"></DIV>
       </DIV>