You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

Making an OpenJPA Release

These instructions guide through the steps of making an official OpenJPA release.

These instructions are specific to the incubating status of OpenJPA. Once OpenJPA is elevated out of incubation, these instructions will need to be updated.

Prerequisites

  1. You should have read the Apache Guide To Release Management During Incubation
  2. You must have shell access to people.apache.org
  3. You must have the following utilities installed on your local machine and available in your path:

Tasks that need to be performed for each release

In the examples below, it is assumed that the current committed version of OpenJPA is 0.9.6-incubating-SNAPSHOT, and the version of the official release will be 0.9.6-incubating

1

Make sure the #One time setup steps have been performed

2

Update the POMs to remove "-SNAPSHOT" from the version. If you have perl installed, you can easily do it with a single command:

 

 
perl -pi -e 's;<version>0.9.6-incubating-SNAPSHOT</version>;<version>0.9.6-incubating</version>;g' pom.xml */pom.xml

3

Commit the POM changes

 

 
svn commit -m "Updated to version 0.9.6-incubating"

4

Perform the build with documentation and install it in the local repository (this step is required because there is a bug in Maven's javadoc generation aggregated between multiple modules):

 

 
mvn clean install -Pdocbook-profile,sign-release

 

This operation will also sign the release files with the gpg utility using the <username>@apache.org key. If your code signing key is under a different address, specify it by appending the following argument to the command above: -Dopenjpa.release.keyAlias=mysigningalias@somedomain.org

5

Verify the signatures:

 

 
gpg --multifile --verify openjpa-project/target/assembly/*.asc

6

Now actually build the javadocs and perform the deploy upload:

 

 
mvn verify deploy -Pjavadoc-profile,sign-release

7

Tag the view with the release number:

 

 
svn copy -m "OpenJPA Release 0.9.6-incubating"
  https://svn.apache.org/repos/asf/incubator/openjpa/trunk 
  https://svn.apache.org/repos/asf/incubator/openjpa/tags/0.9.6-incubating

8

Update the pom.xml files to the subsequent version with the -SNAPSHOT suffix:

 

 
perl -pi -e "s;<version>0.9.6-incubating</version>;<version>0.9.7-incubating-SNAPSHOT</version>;g" pom.xml */pom.xml

9

Commit the POM changes

 

 
svn commit -m "Updated to version 0.9.7-incubating-SNAPSHOT"

10

Start a vote for the release on the open-jpa-dev@incubator.apache.org mailing list. For an example of the mail, see this archived vote

11

If the vote is successful after 3 days, mail general@incubator.apache.org starting a vote for authorization to release

12

Once that vote is successful, update the http://cwiki.apache.org/openjpa/downloads.html page with information about the download

One time setup

These setup steps only need to be performed on a particular machine once.

Developers using Linux workstations can skip over the references to PuTTY and Cygwin

Create and install a SSH key

1

Install PuTTY

2

Use PuttyGen to create a SSH key (see Putty help for details)

3

Use PuTTY to ssh to people.apache.org

4

Create a ~/.ssh folder

5

pscp your SSH public key to ~/authorized_keys

6

ssh to p.a.o

7

Create a ~\.ssh folder and move authorized_keys there

8

Configure putty to use your private key and save the session

Create a PGP key

1

Install cgywin, including utils/gpg

2

Generate a key with $ gpg --gen-key

3

Backup your cygwin home directory to another media

4

Add your key to {{

https://svn.apache.org/repos/asf/incubator/openjpa/site/docs/KEYS

}}

Update Maven settings for our servers

1

Create a settings.xml under .m2 (in your Document and Settings folder in Windows)

 
settings.xml
<settings xmlns="http://maven.apache.org/POM/4.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
    <servers>
       <server>
          <id>people.apache.org</id>
          <username>$USERNAME</username>
          <privateKey>$PATH_TO_PRIVATE_KEY</privateKey>
          <directoryPermissions>775</directoryPermissions>
          <filePermissions>644</filePermissions>
       </server>
    </servers>
</settings>

Expose a copy of known hosts to Maven

1

From cygwin, ssh to people.apache.org, save the public key if prompted, and exit

 

cygwin will save the known hosts to your ~/.ssh folder, but the script cannot access it there (from Windows)

2

From cygwin (not Windows) create another .ssh folder at (question)

3

Copy the known_hosts file to the new .ssh folder

Example shell script to perform the steps above

#!/bin/sh -pve
# Author: Marc Prud'hommeaux <mprudhom@apache.org>
# Performs the release steps described at:
#
#   http://cwiki.apache.org/openjpa/releasing-openjpa.html
# 
# It will do the following:
#
# 1. Check out a fresh version of openjpa
# 2. Update the openjpa pom.xml files to have the new version
# 3. Commit the pom.xml changes
# 4. Make the release files
# 5. Verify the signature
# 6. Test the examples in the release
# 7. Perform the deploy
# 8. Tag the view using "svn copy"
# 9. Update the pom.xml versions to be the next version
# 10. Commit the new pom.xml files

BASEDIR=/tmp/openjpa-staging/
RELEASEDIR=${BASEDIR}/openjpa
EXAMPLESDIR=${BASEDIR}/examples

rm -rf ${BASEDIR} || echo Staging directory already deleted

# OLDVERSION=0.9.6-incubating-SNAPSHOT
# RELEASEVERSION=0.9.6-incubating
# NEXTVERSION=0.9.7-incubating-SNAPSHOT

OLDVERSION=${1}
RELEASEVERSION=${2}
NEXTVERSION=${3}

shift;
shift;
shift;
EXTRAARGS=${@}

# example usage:
# openjpa.mkrelease 0.9.6-incubating-SNAPSHOT 0.9.6-incubating 0.9.7-incubating-SNAPSHOT
# openjpa.mkrelease 0.9.6-incubating-SNAPSHOT 0.9.6-incubating 0.9.7-incubating-SNAPSHOT \
#   -Dopenjpa.release.keyAlias=somegpgkeyalias@somedomain.org

test ! -z ${NEXTVERSION} || echo "Usage: ${0} OLDVERSION RELEASEVERSION NEXTVERSION"
test ! -z ${NEXTVERSION}

svn co https://svn.apache.org/repos/asf/incubator/openjpa/trunk/ ${RELEASEDIR}
cd ${RELEASEDIR}
 
perl -pi -e "s;<version>${OLDVERSION}</version>;<version>${RELEASEVERSION}</version>;g" pom.xml */pom.xml 

svn commit -m "Updated to version ${RELEASEVERSION}" 

# Pre-build: need to do this to get around bugs in aggregate javadocs, as
# well as making a signature we can test
mvn clean install -Pdocbook-profile,sign-release "${EXTRAARGS}"

# Verify the signatures
gpg --multifile --verify openjpa-project/target/assembly/*.asc

# Test the examples to make sure they work
OLDDIR=`pwd`
rm -rf ${EXAMPLESDIR} || true
mkdir -p ${EXAMPLESDIR}
cd ${EXAMPLESDIR}
unzip ${RELEASEDIR}/openjpa-project/target/assembly/*-binary.zip

for build in openjpa-*/examples/*/build.xml
    do
    ant -f ${build}
done

cd ${OLDDIR}

# Now actually build the javadocs and perform the deploy upload
mvn verify deploy -Pjavadoc-profile,sign-release "${EXTRAARGS}"

# Now tag the view
svn copy -m "OpenJPA Release ${RELEASEVERSION}" \
  https://svn.apache.org/repos/asf/incubator/openjpa/trunk \
  https://svn.apache.org/repos/asf/incubator/openjpa/tags/${RELEASEVERSION}

# Update to the next version
perl -pi -e "s;<version>${RELEASEVERSION}</version>;<version>${NEXTVERSION}</version>;g" pom.xml */pom.xml 

# Commit the next versions
svn commit -m "Updated to version ${NEXTVERSION}"

Resources

  • No labels