Excerpt
Instructions for creating an official OpenJPA release
...
Making an OpenJPA 1.0.x or 1.1.x Release
These instructions guide the release manager through the steps of making an official OpenJPA release.
Note |
---|
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
Prerequisites
- You should read the OpenJPA Release Policy to decide on the name of the new release, based on the content.
- You should read the Apache Release FAQ
- You should have read the Apache Guide To Release Management During Incubation
- You must have shell access to people.apache.org
- You must have the following utilities installed on your local machine and available in your path:
...
- For Windows users, install Cygwin in addition to the above utilities
- Make sure the Net/openssh and Utils/gnupg packages are installed that come with Cygwin installation.
- Optional: Putty
...
Tasks that need to be performed for each release
...
In the examples below, it is assumed that the
...
release name will be 1.0.1, and that the current checked-in version name is 1.0.1-SNAPSHOT and stored in the branch named 1.0.x.
Monday, 12:00 1 | Make sure the #One time setup steps have been performed | ||
---|---|---|---|
2 | Run the Release Audit Tool |
| |
Code Block | none | none | |
java -jar ${pathToRat.jar} ${directoryContainingOpenJPA} > rat.output.txt
| |||
Code Block | none | none | |
*****************************************************
Summary
-------
Notes: 6
Binaries: 33
Archives: 0
Standards: 1270
Apache Licensed: 1261
Generated Documents: 0
JavaDocs are generated and so license header is optional
Generated files do not required license headers
9 Unknown Licenses
*******************************
Archives (+ indicates readable, $ unreadable):
*****************************************************
Files with ASL headers will be marked L
Binary files (which do not require ASL headers) will be marked B
Compressed archives will be marked A
Notices, licenses etc will be marked N
N ./README.txt
ASL ./pom.xml
!????? ./rat.output.txt
ASL ./openjpa-all/pom.xml
ASL ./openjpa-examples/pom.xml
ASL ./openjpa-examples/src/main/java/build.xml
ASL ./openjpa-examples/src/main/java/META-INF/persistence.xml
| |||
3 | Verify that LICENSE.txt contains up to date licenses for any dependencies which are included in our distribution. Any jars or source code which is included with the OpenJPA distribution that is not covered by the Apache license must be noted in LICENSE.txt. Two examples of this are the persistence and orm dtds (licensed under the CDDL) and Serp. If any new non Apache dependencies have been introduced they will have to be covered here as well. If any discrepancies are found update LICENSE.txt and commit the changes. | ||
4 | Update BUILDING.txt, CHANGES.txt and RELEASE-NOTES.html | ||
|
| ||
5 | 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 disruptive advances in the trunk from potentially causing problems with the release. A branch can be made by running: |
| |
Code Block | none | none | |
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/branches/0.9.6-incubating
| |||
6 | Update the POMs to remove "-SNAPSHOT" from the version. If you have perl installed, you can easily do it with a single command: |
| |
Code Block | none | none | |
perl -pi -e 's;<version>0.9.6-incubating-SNAPSHOT</version>;<version>0.9.6-incubating</version>;g' pom.xml */pom.xml
| |||
7 | Commit the POM changes |
| |
Code Block | none | none | |
svn commit -m "Updated to version 0.9.6-incubating"
| |||
8 | 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): |
| |
Code Block | none | none | |
mvn clean install -Pdocbook-profile,sign-release
| |||
|
| ||
9 | Verify the signatures: |
| |
Code Block | none | none | |
gpg --multifile --verify openjpa-project/target/assembly/*.asc
| |||
10 | Now actually build the javadocs and perform the deploy upload: |
| |
Code Block | none | none | |
mvn verify deploy -Pjavadoc-profile,sign-release
| |||
11 | Tag the branch with the release number: |
| |
Code Block | none | none | |
svn copy -m "OpenJPA Release 0.9.6-incubating"
https://svn.apache.org/repos/asf/incubator/openjpa/branches/0.9.6-incubating
https://svn.apache.org/repos/asf/incubator/openjpa/tags/0.9.6-incubating
| |||
12 | Update the pom.xml files to the subsequent version with the -SNAPSHOT suffix: |
| |
Code Block | none | none | |
perl -pi -e "s;<version>0.9.6-incubating</version>;<version>0.9.7-incubating-SNAPSHOT</version>;g" pom.xml */pom.xml
| |||
13 | Commit the POM changes |
| |
Code Block | none | none | |
svn commit -m "Updated to version 0.9.7-incubating-SNAPSHOT"
| |||
14 | Start a vote for the release on the open-jpa-dev@incubator.apache.org mailing list. Votes made by committers and members of the OpenJPA project are considered binding for this vote. For an example of the mail, see this archived vote | ||
15 | If the vote is successful after 3 days tally the votes in an email to open-jpa-dev@incubator.apache.org then mail general@incubator.apache.org starting a vote for authorization to release. For this vote only the members of the IPMC are considered binding. A list of the IPMC members can be found here. | ||
16 | Once that vote is successful, update the http://cwiki.apache.org/openjpa/downloads.html page with information about the download | ||
17 | The documentation links at http://cwiki.apache.org/openjpa/documentation.html 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: |
| |
Code Block | none | none | |
mkdir /tmp/openjpa-docs/
cd /tmp/openjpa-docs/
jar xvf OPENJPA_DIR/openjpa-project-0.9.6-incubating-binary.zip
mkdir /tmp/openjpa-site/
cd /tmp/openjpa-site/
svn co https://svn.apache.org/repos/asf/incubator/openjpa/site/docs
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" .
ssh people.apache.org
svn co http://svn.apache.org/repos/asf/incubator/openjpa/site/docs /www/incubator.apache.org/openjpa
| |||
| The static site will take a little while to synchronize, but eventually you should see the new documentation version at http://incubator.apache.org/openjpa/docs/. Once you see that, add a link to the new documentation release at http://cwiki.apache.org/openjpa/documentation.html |
One time setup
These setup steps only need to be performed on a particular machine once.
Info |
---|
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 | |
6 | ssh to p.a.o |
7 | Create a |
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 |
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)
Monday, 12:01 | 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: |
---|---|
Monday, 12:02 | Check out a clean branch from which to build the release: Make sure there is no space characters in the path to the build root subdirectory, i.e. "c:\OpenJPA 1.0.1 Release\build". See "#Space Character in Build Root Path" |
Monday, 12:03 | Update all the POMs to remove "-SNAPSHOT" suffix from the version. If you have perl installed, you can easily do it with a single command: Update the |
Monday, 12:10 | Verify that LICENSE.txt contains up to date licenses for any dependencies which are included in our distribution. |
Monday, 12:15 | Update BUILDING.txt, CHANGES.txt and RELEASE-NOTES.html
|
Monday, 12:20 | Commit the POM changes |
Monday, 12:21 | Perform an initial build and install it in the local repository (this step is only required because of an open bug with Maven's javadoc plugin): |
Monday, 12:23 | Now build the release locally, which will build and test, run the Apache Release Audit Tool to verify license headers, generate the javadoc and docbook PDF and HTML, run through the JPA TCK, build the source and binariy assemblies in target/site/downloads/, and sign the release files. 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 The java14.jar path should be changed to the local install path for the JDK 1.4 rt.jar so that JDK 1.4 verification can take place. The tck.zip path should be changed to the local install path to the JPA TCK so that the TCK can be run against the release. If you are not licensed to access the TCK, remove the The |
Monday, 13:00 | Verify the signatures: |
Monday, 13:01 | Upload the release candidate to http://openjpa.apache.org/builds/1.0.1/downloads/: Bear in mind that uploads to people.apache.org/www/openjpa.apache.org/builds/ are not visible at http://openjpa.apache.org/builds until after the hourly synchronization has taken place, as described at http://www.apache.org/dev/project-site.html. |
Monday, 15:00 | Start a vote for the release on the dev@openjpa.apache.org mailing list. Votes made by committers and members of the OpenJPA project are considered binding for this vote. For an example of the mail, see this archived 1.0.0 vote |
Tuesday, Wednesday | While waiting for the vote to complete, perform whatever manual review and testing on the release you deem appropriate. |
Thursday, 15:00 | If the vote is successful after 3 days tally the votes in an email to dev@openjpa.apache.org, like this one. |
Thursday, 15:10 | Make the OpenJPA assemblies available to the Apache mirroring system by copying them over on people.apache.org: The OpenJPA binary release will be available via the link http://www.apache.org/dyn/closer.cgi/openjpa/1.0.1/apache-openjpa-1.0.1-binary.zip after 24 hours, as per the Apache mirroring information. |
Thursday, 15:15 | Now that the release is locked down, convert the writeable 1.0.1 branch to a (du jure) read-only tag: |
Thursday, 15:16 | Check out the parent branch and bump up the release number to be the next snapshot version: |
Thursday, 15:20 | Update the http://cwiki.apache.org/openjpa/downloads.html page with links to the download mirrors, using the existing entries as templates. All artifacts (apache-openjpa-1.0.1-binary.zip and apache-openjpa-1.0.1-source.zip) must link to the mirrors, but signatures (apache-openjpa-1.0.1-binary.zip.asc and apache-openjpa-1.0.1-source.zip.asc) must not link to mirrors. |
Thursday, 15:30 | The documentation on the server-side must manually be extracted on people.apache.org, and the links at http://openjpa.apache.org/documentation.html need to be updated with the new versions and the "latest" documentation symbolic links need to be updated:
|
Thursday, 15:45 | Merge the staged maven2 repository jars to with the official repository to rsync. This is currently a difficult process that requires the maven-staging-plugin, which much be built from source. The process looks something like this (executed in the root of your local OpenJPA checkout): This process requires Maven 2.0.5. It is currently quite delicate and error-prone. Once the maven-stage-plugin is released, it should be possible to make it more automated. Window/Cygwin user: See #Merging local repository to remote repository in Cygwin/Windows Linux users: You may need to change the '-Dsource=' option to read '-Dsource=file:{}'. The file://{} syntax may result in errors creating the wagon file with errors like: "Repository path /openjpa-jdbc-5/target/site/m2-repository does not exist, and cannot be created." |
Thursday, 16:00 | Update the JIRA versions 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. |
Friday, 16:00 | After the mirrors have had time to update (24 hours to be on the safe side), make a news announcement on the OpenJPA wiki. Once the news item is made, it won't show up on the front page unless you make some minor edit to the containing page (e.g., adding a newline somewhere). |
Friday, 16:05 | Make an announcement about the release on the users@openjpa.apache.org list (and, for major releases, on the announce@apache.org list as per the Apache Announcement Mailing Lists page). The announcement might look something like this. |
Friday, 16:10 | Make an announcement for the freshmeat.net OpenJPA project (optional) |
Friday, 17:00 | Have a beer and enjoy your weekend while the world's grateful programmers revel in yet another high-quality release of Apache OpenJPA! |
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 |
---|---|
2a | Use ssh-keygen to create a SSH key. See Authenticating By Public Key (OpenSSH) for a good description on why and how to perform this task. |
2b | In Windows platform, use PuttyGen to create a SSH key (see Putty help for details).
|
3 | |
4 | Use PuTTY to login to people.apache.org |
5 | Create a |
6 | Move or append
|
7 | Configure putty to use your private key and save the session Specify your private key in the "Connection -> SSH -> Auth" category in Putty configuration. |
Create a PGP key
1 | Install cgywin, including Utils/gnupg and Net/openssh packages, or install gpg from |
---|---|
2 | Generate a key-pair with
|
3 | Backup your cygwin home directory to another media |
4 | Add your public key to |
5 | Following the instructions in http://people.apache.org/~henkp/trust/ and ask someone in the OpenJPA project to sign your public key. |
6 | Submit your public key to a key server. E.g. http://pgp.surfnet.nl:11371/ or http://pgp.mit.edu/ |
Update Maven settings for our servers
1 | Create a settings.xml under .m2 (in your Document and Settings folder in Windows) |
---|---|
| xmlsettings.xmlsolid
|
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 |
2 | From cygwin (not Windows) create another |
3 | Copy the |
Troubleshooting
Space Character in Build Root Path
Description | 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: org.apache.openjpa.revision.propertiessolid |
---|---|
Solution | Rename the path and remove all spaces. |
Merging local repository to remote repository in Cygwin/Windows
Description | 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:
|
---|---|
Solution | As recommended in the descriptions. For example: |
Cygwin/Windows File Path
Description | For Cygwin/Windows user: file and folder path names using drive identifier (e.g. |
---|---|
Solution | Consistently use the following naming conventions:
|
"Too many unapproved licenses:"
Description | Encounter the "Too many unapproved licenses:" message while running the "license-verify-profile" profile in "
|
---|---|
Solution | Avoid the followings:
|
Resources
- Apache Apache Release FAQ
...
...
<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 |
2 | From cygwin (not Windows) create another |
3 | Copy the |
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 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"
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
OLDVERSION=${1}
RELEASEVERSION=${2}
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 ${RELEASEVERSION} || echo "Usage: ${0} OLDVERSION RELEASEVERSION"
test ! -z ${RELEASEVERSION}
# svn co https://svn.apache.org/repos/asf/incubator/openjpa/trunk/ ${RELEASEDIR}
# Check out from the branch (note that a branch with the same name
# as the release version needs to exist)...
SVNBASE="https://svn.apache.org/repos/asf/incubator/openjpa"
TRUNK="${SVNBASE}/trunk"
BRANCH="${SVNBASE}/branches/${RELEASEVERSION}"
TAG="${SVNBASE}/tags/${RELEASEVERSION}"
svn co ${BRANCH} ${RELEASEDIR} ||
\ (echo "$0: Branch does not exist. You can create it \
from the trunk with: svn copy ${TRUNK} ${BRANCH}" && false)
cd ${RELEASEDIR}
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
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}"
# 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}"
Resources
- Apache Guide To Release Management During Incubation
- Signing Releases
- Wendy's notes on Release Signing
- Apache Mirroring Guidelines
- Struts Release Instructions (upon which these instructions are based)