openjpa-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] OpenJPA > New Release Instructions (BETA)
Date Thu, 28 Jan 2010 15:54:00 GMT
<html>
<head>
    <base href="http://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/1519/1/1/_/styles/combined.css?spaceKey=openjpa&amp;forWysiwyg=true"
type="text/css">
    </head>
<body style="background-color: white" bgcolor="white">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
     <h2><a href="http://cwiki.apache.org/confluence/display/openjpa/New+Release+Instructions+%28BETA%29">New
Release Instructions (BETA)</a></h2>
     <h4>Page <b>edited</b> by             <a href="http://cwiki.apache.org/confluence/display/~drwoods">Donald
Woods</a>
    </h4>
     updated release:prepare step to handle publishing tests.jar artifacts and added links
to the JIRA issues explaining the problem
          <div id="versionComment" class="noteMacro" style="display:none; padding: 5px;">
     updated release:prepare step to handle publishing tests.jar artifacts and added links
to the JIRA issues explaining the problem<br />
     </div>
          <br/>
     <div class="notificationGreySide">
         <h1><a name="NewReleaseInstructions%28BETA%29-ReleasingOpenJPA"></a>Releasing
OpenJPA</h1>
<p>These instructions guide the release manager through the steps of making an official
OpenJPA release.</p>

<p><em>Work in progress. Times are just guesses and some information may be missing.</em></p>

<h2><a name="NewReleaseInstructions%28BETA%29-Prerequisites"></a>Prerequisites</h2>

<p>// TODO MDD Still may need some work...</p>

<ol>
	<li>You should read the <a href="/confluence/display/openjpa/OpenJPA+Release+Policy"
title="OpenJPA Release Policy">OpenJPA Release Policy</a> to decide on the name of
the new release, based on the content.</li>
	<li>You should read the Apache <a href="http://www.apache.org/dev/release.html"
rel="nofollow">Release FAQ</a></li>
	<li>You must have shell access to people.apache.org</li>
	<li>You must have the following utilities installed on your local machine and available
in your path:
	<ul>
		<li><a href="http://java.sun.com/" rel="nofollow">JDK 1.4 / 5.0</a> (prefer
Sun JDK over IBM JDK)</li>
		<li><a href="http://maven.apache.org/" rel="nofollow">Maven 2</a> (at
least version 2.0.8)</li>
		<li><a href="http://www.openssh.com/" rel="nofollow">ssh</a> (cygwin covers
this on Windows)</li>
		<li><a href="http://www.gnupg.org/" rel="nofollow">gnupg</a> (cygwin covers
this on Windows)</li>
	</ul>
	</li>
	<li>For Windows users, install <a href="http://cygwin.com/" rel="nofollow">Cygwin</a>
in addition to the above utilities
	<ul>
		<li>Make sure the Net/openssh and Utils/gnupg packages are installed that come with
Cygwin installation.</li>
	</ul>
	</li>
</ol>


<h2><a name="NewReleaseInstructions%28BETA%29-Tasksthatneedtobeperformedforeachrelease"></a>Tasks
that need to be performed for each release</h2>

<p><em>The example below uses 1.2.x as the new branch and 1.2.0 as the new release.</em></p>

<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Monday, 12:00 <br clear="all" /> </th>
<td class='confluenceTd'> Make sure the <a href="#NewReleaseInstructions%28BETA%29-Onetimesetup">One
time setup</a> steps have been performed.
<ul>
	<li>set MAVEN_OPTS=-Xmx512m (for documentation creation)</li>
	<li>Use Sun JDK (if possible)
	<ul>
		<li>If using IBM JDK, then also set the system property test.jvm.arguments to -Xdump:none
(Avoids OOM heap dumps on selected tests.  These extra files throw off the rat:check processing.)
 For example,
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">
mvn -Dtest.jvm.arguments="-Xdump:none" ...
</pre>
</div></div></li>
	</ul>
	</li>
	<li>On Windows, use a cygwin window (vs a standard DOS prompt window) for the Release
processing.</li>
</ul>
</td>
</tr>
<tr>
<th class='confluenceTh'> Monday, 12:01 <br clear="all" /> </th>
<td class='confluenceTd'> Create a sub-branch off of the parent branch from which to
make the release. Releasing from a branch will allow any cosmetic changes that need to be
made for the release to be approved to be done without preventing other more disruptive advances
in the trunk from potentially causing problems with the release. A branch can be made by running:
<br clear="all" />
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">
$ mvn release:branch -DbranchName=1.2.x
</pre>
</div></div> </td>
</tr>
<tr>
<th class='confluenceTh'> Monday, 12:02 <br clear="all" /> </th>
<td class='confluenceTd'> Checkout the branch using command line svn.  
<ul>
	<li>Do not use Eclipse to do the checkout.  The extra dot (.) files created by Eclipse
throws off the rat:check processing.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none"> $ svn checkout https://svn.apache.org/repos/asf/openjpa/branches/1.2.x
1.2.x
$ cd 1.2.x </pre>
</div></div></li>
</ul>
</td>
</tr>
<tr>
<th class='confluenceTh'> Monday, 12:04 <br clear="all" /> </th>
<td class='confluenceTd'> Update the text files which are included in the release. See
instructions at <a href="/confluence/display/openjpa/Update+release+text+files" title="Update
release text files">Update release text files</a> for details.</td>
</tr>
<tr>
</tr>
<tr>
<th class='confluenceTh'> Monday, 12:10 <br clear="all" /> </th>
<td class='confluenceTd'> Commit these changes back to the branch 
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none"> $ svn commit -m "updating text files for 1.2.0 release"
</pre>
</div></div> </td>
</tr>
<tr>
<th class='confluenceTh'> Monday, 12:11 <br clear="all" /> </th>
<td class='confluenceTd'> Do a dry run of the release plugin. The dry run will not commit
any changes back to SVN and gives you the opportunity to verify that the release process will
complete as expected. You will be prompted for the following information :
<ol>
	<li>The new release number (default 1.2.0)</li>
	<li>The SCM tag (default apache-openjpa-1.2.0) *this should be changed to just 1.2.0</li>
	<li>The new development version (default 1.2.1)</li>
	<li><em>optional</em> if you have not specified a GPG passphrase in settings.xml
you will be prompted for it.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">$ mvn -Prelease,docbook-profile release:prepare -DdryRun=true
 
    &lt;snip&gt;
    [INFO] [release:prepare]
    [INFO] Verifying that there are no local modifications...
    [INFO] Executing: svn --non-interactive status
    [INFO] Working directory: /home/mikedd/workspaces/temp/jpadev/branches/1.0.x
    [INFO] Checking dependencies and plugins for snapshots ...
    What is the release version for "OpenJPA"? (org.apache.openjpa:openjpa-parent) 1.2.0:
: 
    What is SCM release tag or label for "OpenJPA"? (org.apache.openjpa:openjpa-parent) openjpa-parent-1.2.0:
: 1.2.0
    What is the new development version for "OpenJPA"? (org.apache.openjpa:openjpa-parent)
1.2.1-SNAPSHOT: : 
    </pre>
</div></div> </li>
</ol>
</td>
</tr>
<tr>
<th class='confluenceTh'> Monday, 12:30 <br clear="all" /> </th>
<td class='confluenceTd'> Validate that the release process completed as expected. The
release plugin will create pom.xml.tag files which contain the changes that would have been
committed to SVN. The only differences between pom.xml.tag and it's corresponding pom.xml
file should be the version number. If other formatting changes have been made you should rollback
the release and commit the changes manually.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">$ mvn -Prelease,docbook-profile release:rollback 
# make changes
$ svn commit -m "fixing formatting for 1.2.0 release" </pre>
</div></div> </td>
</tr>
<tr>
<th class='confluenceTh'> Monday, 12:31 <br clear="all" /> </th>
<td class='confluenceTd'> Assuming the .tag files look OK you may proceed and do any
other validation you feel necessary. The following list may be helpful 
<ul>
	<li>verify signatures <a href="/confluence/display/openjpa/Verifying+release+signatures"
title="Verifying release signatures">Verifying release signatures</a></li>
	<li>run examples. <a href="/confluence/display/openjpa/Running+OpenJPA+Examples"
title="Running OpenJPA Examples">Running OpenJPA Examples</a></li>
	<li>if you have access to the TCK, run it <a href="/confluence/pages/createpage.action?spaceKey=openjpa&amp;title=Running+the+TCK&amp;linkCreation=true&amp;fromPageId=89189"
class="createlink">Running the TCK</a></li>
</ul>
</td>
</tr>
<tr>
<th class='confluenceTh'> Monday, 12:52 <br clear="all" /> </th>
<td class='confluenceTd'> Prepare the release. You'll be prompted for the version information
and optionally your GPG passphrase again.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none"> $ mvn -Dmaven.test.execute=false -Prelease release:prepare </pre>
</div></div>
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16"
align="absmiddle" alt="" border="0"></td><td>You must include the "-Dmaven.test.execute=false"
for the 2.0 branch, as there are problems with the maven-jar-plugin and maven-release-plugin
when using the test-jar goal.  See <a href="http://jira.codehaus.org/browse/MJAR-68" rel="nofollow">http://jira.codehaus.org/browse/MJAR-68</a>
 and <a href="http://jira.codehaus.org/browse/MRELEASE-285" rel="nofollow">http://jira.codehaus.org/browse/MRELEASE-285</a>.</td></tr></table></div></td>
</tr>
<tr>
<th class='confluenceTh'> Monday, 13:12 <br clear="all" /> </th>
<td class='confluenceTd'> Check release.properties and make sure that the scm properties
have the right version. Sometimes the scm location can be the previous version not the next
version. For example if the new version is 1.2.2 you shouldn't see 1.2.1 in the file.  </td>
</tr>
<tr>
<th class='confluenceTh'> Monday, 13:15 <br clear="all" /> </th>
<td class='confluenceTd'> Perform the release. This step will create a maven repository
for use in testing on people.apache.org:/home/userName/public_html/openjpa/newVersion. You
will may be prompted for your people.apache.org password several times if you have not added
a ssh key to .authorized_keys. <a href="#NewReleaseInstructions%28BETA%29-Onetimesetup%23people.apache.org">One
time setup#people.apache.org</a>. 
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">$ mvn -Prelease,docbook-profile release:perform </pre>
</div></div> </td>
</tr>
<tr>
<th class='confluenceTh'> Monday, 13:40 <br clear="all" /> </th>
<td class='confluenceTd'> Create and upload the site. This step also uploads data to
people.apache.org. 
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none"> 
$ cd target/checkout 
$ mvn -Prelease,docbook-profile site site:deploy </pre>
</div></div> </td>
</tr>
<tr>
<th class='confluenceTh'> Monday, 13:40 <br clear="all" /> </th>
<td class='confluenceTd'> Unzip the binary archive the staging site directory
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">
# ssh to people.apache.org 
$ cd ~/public_html/openjpa/1.2.0/staging-site
$ unzip -qq apache-openjpa/downloads/apache-openjpa-1.2.0-binary.zip 
</pre>
</div></div></td>
</tr>
<tr>
<th class='confluenceTh'> Monday, 13:41 <br clear="all" /> </th>
<td class='confluenceTd'> Send an email to dev@openjpa.apache.org requesting a vote.
<a href="http://markmail.org/message/siwhrukuyu64cncg" rel="nofollow">Vote email example</a></td>
</tr>
<tr>
<th class='confluenceTh'> Tuesday, Wednesday, Thursday <br clear="all" /> </th>
<td class='confluenceTd'> A -1 vote does not necessarily mean that the vote must be
redone however it is usually a good idea to rollback the release if a -1 vote is received.
<a href="/confluence/display/openjpa/Recovering+from+a+vetoed+release" title="Recovering
from a vetoed release">Recovering from a vetoed release</a></td>
</tr>
<tr>
<th class='confluenceTh'> Thursday, 13:41 <br clear="all" /> </th>
<td class='confluenceTd'> If the vote passes copy the release artifacts from your home
directory to the ibiblio-rsync-repository using the maven stage plugin. 
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none"> $ mvn stage:copy -Dsource="http://people.apache.org/~mikedd/openjpa/1.2.0/staging-repo"
\
  -Dtarget="scp://people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository"
\
  -Dversion=1.2.0 \
  -DtargetRepositoryId=apache.releases
</pre>
</div></div>
<p>After the stage plugin completes it's a good idea to check the permissions on the
file system. </p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
$ ssh people.apache.org
$ cd /www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/openjpa/
$ ls -l openjpa-examples/1.2.0

# <span class="code-keyword">if</span> you see something like the following you
probably need to change the permissions.
# *-rw-r--r--*  1 mikedd  apcvs  59162 Jul 23 09:34 openjpa-examples-1.2.0-javadoc.jar

$ <span class="code-keyword">for</span> file in `find /www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/openjpa/
-type d -iname '1.2.0'`\
  <span class="code-keyword">do</span> \
  chmod -R g+w ${file} \ 
  done

$ ls -l openjpa-examples/1.2.0

# Now it should look something like <span class="code-keyword">this</span>
# *-rw-rw--r--*  1 mikedd  apcvs  59162 Jul 23 09:34 openjpa-examples-1.2.0-javadoc.jar
</pre>
</div></div></td>
</tr>
<tr>
<th class='confluenceTh'> Thursday, 14:00 <br clear="all" /> </th>
<td class='confluenceTd'> Copy build artifacts to the openjpa/builds location on people.apache.org.

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none"># ssh to people.apache.org
$ cp -r ~/public_html/openjpa/1.2.0/staging-site/ /www/openjpa.apache.org/builds/1.2.0
$ chmod -R g+w /www/openjpa.apache.org/builds/1.2.0
# verify that /www/openjpa.apache.org/builds/1.2.0/docs/manual is populated correctly by comparing
it to a previous release. 
$ rm /www/openjpa.apache.org/docs/latest
$ ln -fvs ../builds/1.2.0/apache-openjpa/docs/ /www/openjpa.apache.org/docs/latest </pre>
</div></div> </td>
</tr>
<tr>
<th class='confluenceTh'> Thursday, 14:10 <br clear="all" /> </th>
<td class='confluenceTd'> Copy the distribution files to dist on people.apache.org.

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none"> 
# ssh to people.apache.org

# verify that md5 and sha1 files were generated for the download artifacts
ls /www/openjpa.apache.org/builds/1.2.0/apache-openjpa/downloads/*.md5
ls /www/openjpa.apache.org/builds/1.2.0/apache-openjpa/downloads/*.sha1

# if no md5 and sha1 files are present, generate them. 
# Alternatively you can copy the artifacts from the staging-repo directory the checksums are
generated there.
for file in `ls . ` 
do 
md5 -q ${file} &gt; ${file}.md5
sha1 -q ${file} &gt; ${file}.sha1
done

mkdir /www/www.apache.org/dist/openjpa/1.2.0
cp -r /www/openjpa.apache.org/builds/1.2.0/apache-openjpa/downloads/* /www/www.apache.org/dist/openjpa/1.2.0
chgrp -R openjpa /www/www.apache.org/dist/openjpa/1.2.0
chmod -R g+w /www/www.apache.org/dist/openjpa/1.2.0

# remove the previous version from /dist. Ie if you're publishing 1.2.1 you would remove 1.2.0.
# For this example we wouldn't remove anything, but for the next release (1.2.1) we'd do the
following : 
$ rm -Rf /www/openjpa.apache.org/dist/openjpa/1.2.0
</pre>
</div></div></td>
</tr>
<tr>
<th class='confluenceTh'> Thursday, 14:15 </th>
<td class='confluenceTd'> Update the <a href="https://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12310351"
rel="nofollow">JIRA versions </a> page to mark the version as "released", and set
the date to the date that the release was approved. You may also need to make a new release
entry for the subsequent release.</td>
</tr>
<tr>
<th class='confluenceTh'> Friday, 14:15 </th>
<td class='confluenceTd'> After the mirrors have had time to update (24 hours to be
on the safe side) update the <a href="http://openjpa.apache.org/downloads.html" rel="nofollow">downloads
page</a> with the new release </td>
</tr>
<tr>
<th class='confluenceTh'> Friday, 14:15 </th>
<td class='confluenceTd'> Make a <a href="http://cwiki.apache.org/confluence/pages/createblogpost.action?spaceKey=openjpa"
rel="nofollow">news announcement</a> on the OpenJPA wiki. <div class='panelMacro'><table
class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16"
align="absmiddle" alt="" border="0"></td><td>Once the news item is made, it
won't show up on the <a href="http://cwiki.apache.org/openjpa/" rel="nofollow">front
page</a> unless you make some minor edit to the containing page (e.g., adding a newline
somewhere).</td></tr></table></div> </td>
</tr>
<tr>
<th class='confluenceTh'> Friday, 14:15 </th>
<td class='confluenceTd'> Make an announcement about the release on the <a href="mailto:users@openjpa.apache.org"
rel="nofollow">users@openjpa.apache.org</a> list (and, for major releases, on the
<a href="mailto:announce@apache.org" rel="nofollow">announce@apache.org</a> list
as per <a href="http://www.apache.org/foundation/mailinglists.html#foundation-announce"
rel="nofollow">the Apache Announcement Mailing Lists page</a>). The announcement
might look something like <a href="http://www.nabble.com/-ANNOUNCE--Apache-OpenJPA-1.0.0-released-p12397604.html"
rel="nofollow">this</a>. </td>
</tr>
<tr>
<th class='confluenceTh'> Friday, 14:20 </th>
<td class='confluenceTd'> Make an announcement for the <a href="http://freshmeat.net/projects/openjpa/"
rel="nofollow">freshmeat.net OpenJPA project</a> (optional) </td>
</tr>
<tr>
<th class='confluenceTh'> Friday, 14:30 </th>
<td class='confluenceTd'> Have a beer and enjoy your weekend while the world's grateful
programmers revel in yet another high-quality release of Apache OpenJPA! </td>
</tr>
</tbody></table>

<h2><a name="NewReleaseInstructions%28BETA%29-Onetimesetup"></a>One time
setup</h2>

<p>These setup steps only need to be performed on a particular machine once.</p>
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/information.gif" width="16"
height="16" align="absmiddle" alt="" border="0"></td><td>Developers using Linux
workstations can skip over the references to Cygwin.  If using Windows, install cygwin, including
<b>Utils/gnupg</b> and <b>Net/openssh</b> packages.</td></tr></table></div>

<h3><a name="NewReleaseInstructions%28BETA%29-CreateandinstallaSSHkey"></a>Create
and install a SSH key</h3>

<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> 1 </th>
<td class='confluenceTd'> Open a shell window.  If using Windows, open a cygwin window.
 </td>
</tr>
<tr>
<th class='confluenceTh'> 2 </th>
<td class='confluenceTd'> Use ssh-keygen to create an SSH key.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">
$ ssh-keygen -t dsa
</pre>
</div></div>
<ul>
	<li>Program defaults should be fine.  No passphrase is required for the ssh key generation.
 The keys will be saved in ~/.ssh/id_dsa (private) and ~/.ssh/id_dsa.pub (public).
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/information.gif" width="16"
height="16" align="absmiddle" alt="" border="0"></td><td> See <a href="http://www.networknewz.com/networknewz-10-20030707AuthenticatingbyPublicKeyOpenSSH.html"
rel="nofollow">Authenticating By Public Key (OpenSSH)</a> for a good description
on why and how to perform this task.</td></tr></table></div> </li>
</ul>
</td>
</tr>
<tr>
<th class='confluenceTh'> 3 </th>
<td class='confluenceTd'> <tt>scp</tt> your SSH public key ~/.ssh/id_dsa.pub
created in last step to ~/id_dsa.pub on people.apache.org.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none"> 
$ cd ~/.ssh
$ scp id_dsa.pub &lt;your userid&gt;@people.apache.org:id_dsa.pub 
$ You will be prompted for your password.
</pre>
</div></div>  </td>
</tr>
<tr>
<th class='confluenceTh'> 4 </th>
<td class='confluenceTd'> Use ssh to login to people.apache.org 
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">
$ cd ~
$ ssh &lt;your userid&gt;@people.apache.org
</pre>
</div></div>
<ul>
	<li>At this point, you will still be prompted for your password.</li>
</ul>
</td>
</tr>
<tr>
<th class='confluenceTh'> 5 </th>
<td class='confluenceTd'> Create a ~/.ssh folder in your home directory on people.apache.org
and change its file mode to 700.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">
$ mkdir ~/.ssh
$ chmod 700 ~/.ssh
</pre>
</div></div>  </td>
</tr>
<tr>
<th class='confluenceTh'> 6 </th>
<td class='confluenceTd'> Move or append ~/id_dsa.pub to ~/.ssh/authorized_keys and
change its file mode to 600.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">
$ mv ~/id_dsa.pub ~/.ssh/authorized_keys
$ chmod 600 ~/.ssh/authorized_keys
</pre>
</div></div>
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/information.gif" width="16"
height="16" align="absmiddle" alt="" border="0"></td><td><ul>
	<li>Each public key in the <tt>authorized_keys</tt> spans only one line.
	<ul>
		<li>For example: "<tt>ssh-dss AAAAB3NzaC1kc3MAAA ..... agBmmfZ9uAbSqA== dsa-key-20071107</tt>"</li>
	</ul>
	</li>
	<li>'#' in the first column is a comment line.</li>
</ul>
</td></tr></table></div> </td>
</tr>
<tr>
<th class='confluenceTh'> 7 </th>
<td class='confluenceTd'> Exit out of this ssh session.  </td>
</tr>
<tr>
<th class='confluenceTh'> 8 </th>
<td class='confluenceTd'> Start a new ssh session.  No login should be required this
time due to the private ssh key on your local box matching up with the public ssh key in your
home directory (~/.ssh).
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">
$ ssh &lt;your userid&gt;@people.apache.org
</pre>
</div></div> 
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/information.gif" width="16"
height="16" align="absmiddle" alt="" border="0"></td><td><p>If you are
still prompted for a password, then you have not set up the ssh keys properly.  Review the
steps above and ensure that all of the steps were followed properly.  Or, maybe the instructions
are still not quite right and they still need some adjusting.  In that case, please update
the instructions accordingly.  <img class="emoticon" src="/confluence/images/icons/emoticons/smile.gif"
height="20" width="20" align="absmiddle" alt="" border="0"/></p></td></tr></table></div></td>
</tr>
<tr>
</tr>
</tbody></table>

<h3><a name="NewReleaseInstructions%28BETA%29-CreateaGPGkey"></a>Create
a GPG key</h3>

<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> 1 </th>
<td class='confluenceTd'> Open a shell window.  If using Windows, open a cygwin window.
</td>
</tr>
<tr>
<th class='confluenceTh'> 2 </th>
<td class='confluenceTd'> Generate a key-pair with gpg, using default key kind ("DSA
and Elgamal") and ELG-E keys size (2048).
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">
$ gpg --gen-key
</pre>
</div></div>
<ul>
	<li>The program's default values should be fine.  For the "Real Name" enter your full
name (ie. Stan Programmer).  For the "e-mail address" enter your apache address (ie. sprogrammer@apache.org).
 You will also be required to enter a "passphrase" for the GPG key generation.  Keep track
of this as you will need this for the Release processing.
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/information.gif" width="16"
height="16" align="absmiddle" alt="" border="0"></td><td><ul>
	<li>The generated keys are stored in $HOME/.gnupg or %HOME%\Application Data\gnupg
subdirectory.</li>
	<li>Save the content in this subdirectory to a safe media. This contains your private
key used to sign all the OpenJPA release materials.</li>
</ul>
</td></tr></table></div> </li>
</ul>
</td>
</tr>
<tr>
<th class='confluenceTh'> 3 </th>
<td class='confluenceTd'> Backup your cygwin home directory to another media </td>
</tr>
<tr>
<th class='confluenceTh'> 4 </th>
<td class='confluenceTd'> Add your public key to <tt><a href="https://svn.apache.org/repos/asf/openjpa/site/docs/KEYS"
rel="nofollow">https://svn.apache.org/repos/asf/openjpa/site/docs/KEYS</a></tt>
and <tt><a href="http://www.apache.org/dist/openjpa/KEYS" rel="nofollow">http://www.apache.org/dist/openjpa/KEYS</a></tt>.
See the commands describe at the beginning of this KEYS file to perform this task. The gpg
key-pair is used to sign the published artifacts for the OpenJPA releases. 
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-none">
$ gpg --list-sigs &lt;Real Name&gt; &amp;&amp; gpg --armor -- export &lt;Real
Name&gt;
</pre>
</div></div>
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/information.gif" width="16"
height="16" align="absmiddle" alt="" border="0"></td><td>The <tt><a
href="https://svn.apache.org/repos/asf/openjpa/site/docs/KEYS" rel="nofollow">https://svn.apache.org/repos/asf/openjpa/site/docs/KEYS</a></tt>
file is updated via normal svn commit procedures.  How the <tt><a href="http://www.apache.org/dist/openjpa/KEYS"
rel="nofollow">http://www.apache.org/dist/openjpa/KEYS</a></tt> file gets updated
is still a mystery to me...</td></tr></table></div> </td>
</tr>
<tr>
<th class='confluenceTh'> 5 </th>
<td class='confluenceTd'> Following the instructions in <a href="http://people.apache.org/~henkp/trust/"
rel="nofollow">http://people.apache.org/~henkp/trust/</a> and ask someone in the
OpenJPA project to sign your public key. </td>
</tr>
<tr>
<th class='confluenceTh'> 6 </th>
<td class='confluenceTd'> Submit your public key to a key server. E.g. <a href="http://pgp.surfnet.nl:11371/"
rel="nofollow">http://pgp.surfnet.nl:11371/</a> or <a href="http://pgp.mit.edu/"
rel="nofollow">http://pgp.mit.edu/</a></td>
</tr>
</tbody></table>

<h3><a name="NewReleaseInstructions%28BETA%29-UpdateMavensettingsforourservers"></a>Update
Maven settings for our servers</h3>

<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> 1 </th>
<td class='confluenceTd'> Create a settings.xml under .m2 (in your Document and Settings
folder in Windows) </td>
</tr>
<tr>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> <div class="code panel" style="border-style: solid;border-width:
1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;border-bottom-style:
solid;"><b>settings.xml</b></div><div class="codeContent panelContent">
<pre class="code-xml">
&lt;settings xmlns=<span class="code-quote">"http://maven.apache.org/POM/4.0.0"</span>
          <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span>
          xsi:schemaLocation=<span class="code-quote">"http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd"</span>&gt;
    <span class="code-tag">&lt;servers&gt;</span>
       <span class="code-tag">&lt;server&gt;</span>
          <span class="code-tag">&lt;id&gt;</span>people.apache.org<span
class="code-tag">&lt;/id&gt;</span>
          <span class="code-tag">&lt;username&gt;</span>$USERNAME<span
class="code-tag">&lt;/username&gt;</span>
          <span class="code-tag">&lt;privateKey&gt;</span>$PATH_TO_PRIVATE_KEY<span
class="code-tag">&lt;/privateKey&gt;</span>
          <span class="code-tag">&lt;directoryPermissions&gt;</span>775<span
class="code-tag">&lt;/directoryPermissions&gt;</span>
          <span class="code-tag">&lt;filePermissions&gt;</span>644<span
class="code-tag">&lt;/filePermissions&gt;</span>
       <span class="code-tag">&lt;/server&gt;</span>
    <span class="code-tag">&lt;/servers&gt;</span>    
<span class="code-tag">&lt;/settings&gt;</span>
</pre>
</div></div>
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/information.gif" width="16"
height="16" align="absmiddle" alt="" border="0"></td><td><ul>
	<li><tt>$USERNAME</tt> is the remote username on people.apache.org, not
your local userid.</li>
	<li><tt>$PATH_TO_PRIVATE_KEY</tt> is the path to the private key generated
for ssh. E.g. /home/yourLocalUserId/.ssh/id_dsa.  For Windows' cygwin users, you will need
to enter the full cygwin path:  /cygdrive/c/cygwin/home/yourLocalUserId/.ssh/id_dsa.</li>
	<li>You can also enter a PGP passphrase stanza:  &lt;passphrase&gt;..&lt;/passphrase&gt;.
 If you don't use this in your settings.xml file, then you will be prompted for it during
the Release processing.</li>
</ul>
</td></tr></table></div> </td>
</tr>
</tbody></table>

<h3><a name="NewReleaseInstructions%28BETA%29-ExposeacopyofknownhoststoMaven"></a>Expose
a copy of known hosts to Maven</h3>
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/information.gif" width="16"
height="16" align="absmiddle" alt="" border="0"></td><td><p>Is this step
even necessary?  Due to the question mark below without an explanation of the new location
for this alternate .ssh folder, I never performed these steps.  And, the release process still
seemed to work okay for me...  The next person to use these instructions can verify whether
any tricks had to be played with the .ssh folders...</p></td></tr></table></div>

<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> 1 </th>
<td class='confluenceTd'> From cygwin, ssh to people.apache.org, save the public key
if prompted, and exit </td>
</tr>
<tr>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> cygwin will save the known hosts to your <tt>&#126;/.ssh</tt>
folder, but the script cannot access it there (from Windows) </td>
</tr>
<tr>
<th class='confluenceTh'> 2 </th>
<td class='confluenceTd'> From cygwin (not Windows) create another <tt>.ssh</tt>
folder at <img class="emoticon" src="/confluence/images/icons/emoticons/help_16.gif" height="16"
width="16" align="absmiddle" alt="" border="0"/> </td>
</tr>
<tr>
<th class='confluenceTh'> 3 </th>
<td class='confluenceTd'> Copy the <tt>known_hosts</tt> file to the new
<tt>.ssh</tt> folder </td>
</tr>
</tbody></table>

<h2><a name="NewReleaseInstructions%28BETA%29-Troubleshooting"></a>Troubleshooting</h2>

<h3><a name="NewReleaseInstructions%28BETA%29-SpaceCharacterinBuildRootPath"></a>Space
Character in Build Root Path</h3>

<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Description </th>
<td class='confluenceTd'> If there are spaces in the path to the build root subdirectory,
the maven task uses to generate the revision number for the org.apache.openjpa.revision.properties
yields incorrect data. For example:
<div class="code panel" style="border-style: solid;border-width: 1px;"><div class="codeHeader
panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;"><b>org.apache.openjpa.revision.properties</b></div><div
class="codeContent panelContent">
<pre class="code-java">
revision.number=Type 'svnversion --help' <span class="code-keyword">for</span>
usage.
openjpa.version=1.0.1
</pre>
</div></div> </td>
</tr>
<tr>
<th class='confluenceTh'> Solution </th>
<td class='confluenceTd'> Rename the path and remove all spaces. </td>
</tr>
</tbody></table>

<h3><a name="NewReleaseInstructions%28BETA%29-MerginglocalrepositorytoremoterepositoryinCygwin%2FWindows"></a>Merging
local repository to remote repository in Cygwin/Windows</h3>

<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Description </th>
<td class='confluenceTd'> The "maven-stage-plugin" is very sensitive to the parameters
being passed to it, i.e. the source and target URL properties. When this plugin is used under
Cygwin, make sure the following practices are used:
<ul>
	<li>Use absolute path in the find command's root directory. <br clear="all" />
Problem symptom:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
$ find . -name m2-repository -not -path <span class="code-quote">"*openjpa-project*"</span>
\
    -exec mvn -f <span class="code-quote">"c:/tmp/maven-stage-plugin/pom.xml"</span>
stage:copy \
    -Dsource=file:<span class="code-comment">//{} -Dtarget=scp://allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository
\
</span>    -Dversion=1.0.1 \;
[INFO] Scanning <span class="code-keyword">for</span> projects...
[INFO] Searching repository <span class="code-keyword">for</span> plugin with
prefix: 'stage'.
........
[INFO] Downloading file from the source repository:
[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] Error copying repository from file:<span class="code-comment">//./openjpa-all/target/site/m2-repository
to \
</span>       scp:<span class="code-comment">//allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository</span>
</pre>
</div></div></li>
	<li>Quote and use the drive name in the path.<br/>
Problem symptom:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
$ find /cygdrive/c/OpenJPA.1.0.1.Release/1.0.1 -name m2-repository -not -path <span class="code-quote">"*openjpa-project*"</span>
\
    -exec mvn -f /cygwin/c/tmp/maven-stage-plugin/pom.xml stage:copy \
    -Dsource=file:<span class="code-comment">//{} -Dtarget=scp://allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository
\
</span>    -Dversion=1.0.1 \;
[INFO] Scanning <span class="code-keyword">for</span> projects...
[INFO] Searching repository <span class="code-keyword">for</span> plugin with
prefix: 'stage'.
........
[INFO] Downloading file from the source repository:
[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] Error copying repository from file:<span class="code-comment">///cygdrive/c/OpenJPA.1.0.1.Release/1.0.1/openjpa-all/target/site/m2-repository
to
</span>       scp:<span class="code-comment">//allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository
</span>
Embedded error: Could not read from file: c:\cygdrive\c\OpenJPA.1.0.1.Release\1.0.1\openjpa-all\target\site\m2-repository
\cygdrive\c\OpenJPA.1.0.1.Release\1.0.1\openjpa-all\target\site\m2-repository (Access is denied.)
</pre>
</div></div></li>
	<li>Specify the people.apache.org user id in the target property.<br/>
Problem symptom:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
$ find <span class="code-quote">"c:/OpenJPA.1.0.1.Release/1.0.1"</span> -name
m2-repository -not -path <span class="code-quote">"*openjpa-project*"</span> \
   -exec mvn -f <span class="code-quote">"c:/tmp/maven-stage-plugin/pom.xml"</span>
stage:copy 
   -Dsource=file:<span class="code-comment">//{} -Dtarget=scp://people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository
\
</span>   -Dversion=1.0.1 \;
[INFO] Scanning <span class="code-keyword">for</span> projects...
[INFO] Searching repository <span class="code-keyword">for</span> plugin with
prefix: 'stage'.
[INFO] ----------------------------------------------------------------------------
........
[INFO] Downloading file from the source repository: /org/apache/openjpa/openjpa/maven-metadata.xml.sha1
[INFO] Downloading metadata from the target repository.
Password:: *********
........
Password:: *********
[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] Error copying repository from file:<span class="code-comment">//c:/OpenJPA.1.0.1.Release/1.0.1/openjpa-all/target/site/m2-repository
to \
</span>       scp:<span class="code-comment">//people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository</span>
</pre>
</div></div> </li>
</ul>
</td>
</tr>
<tr>
<th class='confluenceTh'> Solution </th>
<td class='confluenceTd'> As recommended in the descriptions.
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16"
align="absmiddle" alt="" border="0"></td><td>For example:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
find <span class="code-quote">"c:/OpenJPA.1.0.1.Release/1.0.1"</span> -name m2-repository
-not -path <span class="code-quote">"*openjpa-project*"</span> \
    -exec mvn -f <span class="code-quote">"c:/tmp/maven-stage-plugin/pom.xml"</span>
stage:copy \
    -Dsource=file:<span class="code-comment">//{} \
</span>    -Dtarget=scp:<span class="code-comment">//allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository
\
</span>    -Dversion=1.0.1 \;
</pre>
</div></div> </td></tr></table></div> </td>
</tr>
</tbody></table>

<h3><a name="NewReleaseInstructions%28BETA%29-Cygwin%2FWindowsFilePath"></a>Cygwin/Windows
File Path</h3>

<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Description </th>
<td class='confluenceTd'> For Cygwin/Windows user: file and folder path names using
drive identifier (e.g. <tt>C:\OpenJPA Release\1.0.1</tt> ) in commands can be
expressed as <tt>/cygwin/c/OpenJPA Release/1.0.1/</tt>. This form of path name
specification may have inconsistent and undesirable behaviors.</td>
</tr>
<tr>
<th class='confluenceTh'> Solution </th>
<td class='confluenceTd'> Consistently use the following naming conventions:
<ul>
	<li>Continue to use the Windows form of path name, e.g. <tt>C:\a\b\c</tt></li>
	<li>Use <tt>'/'</tt> instead of <tt>'\'</tt> character as file
separator, e.g. <tt>C:/a/b/c</tt></li>
	<li>Quote all path name using <tt>'"'</tt> character, e.g. "<tt>C:/a/b/c</tt>"</li>
	<li>Avoid using space characters in path name, e.g. "<tt>C:/OpenJPA.Release/1.0.1</tt>"</li>
</ul>
</td>
</tr>
<tr>
</tr>
</tbody></table>

<h3><a name="NewReleaseInstructions%28BETA%29-%22Toomanyunapprovedlicenses%3A%22"></a>"Too
many unapproved licenses:"</h3>

<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Description </th>
<td class='confluenceTd'> Encounter the "Too many unapproved licenses:" message while
running the "license-verify-profile" profile in "<tt>mvn deploy site...</tt>"
step. This is caused by extra artifacts in the build tree that the license verification plugin
does not recognized. Examples of these artifacts are:
<ol>
	<li>Eclipse control files, .classpath, .project</li>
	<li>User created log files</li>
</ol>
</td>
</tr>
<tr>
<th class='confluenceTh'> Solution </th>
<td class='confluenceTd'> Avoid the followings:
<ol>
	<li>Don't use Eclipse's svn plugin to "Check out" files to a Eclipse project. Simply
use the svn command, as described in the release instructions.</li>
	<li>Don't create, directly or indirectly, any files under the release build tree.</li>
	<li>Don't use the IBM JDK.  By default, the IBM JDK will create heap dumps when hitting
the OOM condition in some of our tests.  These extra files throw off the rat:check processing.
 If you must use the IBM JDK, then also set MAVEN_OPTS=-Xdump:none.</li>
</ol>
</td>
</tr>
<tr>
</tr>
</tbody></table>

<h2><a name="NewReleaseInstructions%28BETA%29-Resources"></a>Resources</h2>

<ul>
	<li>Apache Apache <a href="http://www.apache.org/dev/release.html" rel="nofollow">Release
FAQ</a></li>
	<li><a href="http://apache.org/dev/release-signing.html" rel="nofollow">Signing
Releases</a></li>
	<li><a href="http://wiki.wsmoak.net/cgi-bin/wiki.pl?ReleaseSigning" rel="nofollow">Wendy's
notes on Release Signing</a></li>
	<li>Apache <a href="http://apache.org/dev/mirrors.html" rel="nofollow">Mirroring
Guidelines</a></li>
	<li>Struts <a href="http://cwiki.apache.org/WW/creating-and-signing-a-distribution.html"
rel="nofollow">Release Instructions</a> (upon which these instructions are based)</li>
</ul>

     </div>
     <div id="commentsSection" class="wiki-content pageSection">
       <div style="float: right;">
            <a href="http://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
       </div>

       <a href="http://cwiki.apache.org/confluence/display/openjpa/New+Release+Instructions+%28BETA%29">View
Online</a>
       |
       <a href="http://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=89189&revisedVersion=24&originalVersion=23">View
Change</a>
              |
       <a href="http://cwiki.apache.org/confluence/display/openjpa/New+Release+Instructions+%28BETA%29?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
            </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message