Releasing OpenJPA has been edited by Marc Prud'hommeaux (Dec 11, 2006).

(View changes)


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.


  1. You should have read the Apache Guide To Release Management During Incubation
  2. You must have shell access to
  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 If releasing from the trunk, first make a 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 distruptive advances in the trunk from potentially causing problems with the release. A branch can be made by running:
svn copy -m "OpenJPA Release 0.9.6-incubating"
3 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
4 Commit the POM changes
svn commit -m "Updated to version 0.9.6-incubating"
5 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> key. If your code signing key is under a different address, specify it by appending the following argument to the command above:
6 Verify the signatures:
gpg --multifile --verify openjpa-project/target/assembly/*.asc
7 Now actually build the javadocs and perform the deploy upload:
mvn verify deploy -Pjavadoc-profile,sign-release
8 Tag the branch with the release number:
svn copy -m "OpenJPA Release 0.9.6-incubating"
9 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
10 Commit the POM changes
svn commit -m "Updated to version 0.9.7-incubating-SNAPSHOT"
11 Start a vote for the release on the mailing list. For an example of the mail, see this archived vote
12 If the vote is successful after 3 days, mail starting a vote for authorization to release
13 Once that vote is successful, update the page with information about the download
14 The documentation links at also needs to be updated. You can do this by checking out a copy of the OpenJPA static site documents into a scratch directory, unpacking the OpenJPA binary into the docs section, adding the new docs, and then committing and updating the docs on the server-side:
mkdir /tmp/openjpa-docs/
cd /tmp/openjpa-docs/
jar xvf OPENJPA_DIR/

mkdir /tmp/openjpa-site/
cd /tmp/openjpa-site/
svn co

cd docs/docs/
mv /tmp/openjpa-docs/openjpa-0.9.6-incubating/docs/ openjpa-0.9.6-incubating
rm latest
ln -s openjpa-0.9.6-incubating latest

svn add openjpa-0.9.6-incubating
svn commit -m "Added documentation for openjpa-0.9.6-incubating release" .

svn co /www/
  The static site will take a little while to synchronize, but eventually you should see the new documentation version at Once you see that, add a link to the new documentation release at

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
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

Update Maven settings for our servers

1 Create a settings.xml under .m2 (in your Document and Settings folder in Windows)
<settings xmlns=""

Expose a copy of known hosts to Maven

1 From cygwin, ssh to, 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
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 <>
# Performs the release steps described at:
# It will do the following:
# 1. Check out a fresh version of openjpa from the branch
# 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"


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

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



# 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


# svn co ${RELEASEDIR}

# Check out from the branch (note that a branch with the same name as the release version needs to exist)...

svn co ${BRANCH} ${RELEASEDIR} || (echo "$0: Branch does not exist. You can create it from the trunk with: svn copy ${TRUNK} ${BRANCH}" && false)

grep "<version>${OLDVERSION}</version>" pom.xml || echo "ERROR: version is not the expected version (${OLDVERSION})"
grep "<version>${OLDVERSION}</version>" pom.xml

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
rm -rf ${EXAMPLESDIR} || true
mkdir -p ${EXAMPLESDIR}
unzip ${RELEASEDIR}/openjpa-project/target/assembly/*

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

cd ${OLDDIR}

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

# Remove any identical tag
svn delete -m "Removed old ${RELEASEVERSION} tag for re-tagging" ${TAG} || echo "Tag does not already exist, so does not need to be removed"

# Now tag the view
svn copy -m "OpenJPA Release ${RELEASEVERSION}" ${BRANCH} ${TAG}

# We don't do this anymore since we release from branches, not from trunk
# 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}"


Powered by Atlassian Confluence (Version: 2.2.9 Build:#527 Sep 07, 2006) - Bug/feature request

Unsubscribe or edit your notifications preferences