Make sure the #One time setup steps have been performed

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:

svn copy -m "OpenJPA Release 1.0.1 branch" \
  https://svn.apache.org/repos/asf/openjpa/branches/1.0.x \
  https://svn.apache.org/repos/asf/openjpa/branches/1.0.1

Check out a clean branch from which to build the release:

svn checkout https://svn.apache.org/repos/asf/openjpa/branches/1.0.1
cd 1.0.1

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:

perl -pi -e "s;<version>1.0.1-SNAPSHOT</version>;<version>1.0.1</version>;g" \
    pom.xml */pom.xml */*/pom.xml

Update the <scm.dir> property in the top level pom.xml to the 1.0.1 release. \
Update the <developer> element in the top level pom.xml if new committers are added or removed. This applies to the 1.0.x branch only.

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.

Update BUILDING.txt, CHANGES.txt and RELEASE-NOTES.html

• BUILDING.txt should be included in the source tarball and contains instructions on how to build OpenJPA. Prior to shipping a release we should ensure that those instructions are accurate.
• CHANGES.txt contains a text representation of all the changes which have been made since the preceding release. Most of the contents of this file can be generated through JIRA's release notes mechanism here
• RELEASE-NOTES.html contains general information on the OpenJPA project as well as an html version of the changes since the preceding version. The html change log may also be generated via JIRA.
  

Commit the POM changes

svn commit -m "Updated to version 1.0.1 for the release"

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

mvn clean install -Dtest=false

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.

export MAVEN_OPTS=-Xmx1000m
mvn --batch-mode deploy site \
    -Ptck-profile,examples-profile,license-verify-profile,javadoc-profile,docbook-profile,sign-release \
    -Djava14.jar=${JAVA_HOME}/../../1.4/Classes/classes.jar \
    -Dtck.zip=${HOME}/.m2/privaterepos/jpa-1_0b-tck.zip

mkdir openjpa-integration\examples\target\examples
unzip target\site\downloads\apache-openjpa-1.0.1-binary.zip -d openjpa-integration\examples\target\examples
cd openjpa-integration\examples\target\examples\apache-openjpa-1.0.1\examples\hellojpa
ant
cd ..\relations
ant
cd ..\reversemapping
ant

Verify the signatures:

gpg --multifile --verify target/site/downloads/*.asc

Upload the release candidate to http://openjpa.apache.org/builds/1.0.1/downloads/:

mvn site:deploy

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

While waiting for the vote to complete, perform whatever manual review and testing on the release you deem appropriate.

If the vote is successful after 3 days tally the votes in an email to dev@openjpa.apache.org, like this one.

Make the OpenJPA assemblies available to the Apache mirroring system by copying them over on people.apache.org:

ssh people.apache.org
cp -r /www/openjpa.apache.org/builds/1.0.1/downloads/* /www/www.apache.org/dist/openjpa/1.0.1
chgrp -R openjpa /www/www.apache.org/dist/openjpa/1.0.1
chmod -R g+w /www/www.apache.org/dist/openjpa/1.0.1

Now that the release is locked down, convert the writeable 1.0.1 branch to a (du jure) read-only tag:

svn mv -m "OpenJPA Release 1.0.1 tag" \
  https://svn.apache.org/repos/asf/openjpa/branches/1.0.1 \
  https://svn.apache.org/repos/asf/openjpa/tags/1.0.1

Check out the parent branch and bump up the release number to be the next snapshot version:

svn checkout https://svn.apache.org/repos/asf/openjpa/branches/1.0.x
cd 1.0.x
perl -pi -e "s;<version>1.0.1-SNAPSHOT</version>;<version>1.0.2-SNAPSHOT</version>;g" \
    pom.xml */pom.xml */*/pom.xml
svn commit -m "Updating version in branch to 1.0.2-SNAPSHOT"

Update the http://cwiki.apache.org/openjpa/downloads.html page with links to the download mirrors, using the existing entries as templates.

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:

cd /www/openjpa.apache.org/builds/1.0.1/
unzip downloads/apache-openjpa-1.0.1-binary.zip
rm /www/openjpa.apache.org/docs/latest
ln -fvs ../builds/1.0.1/apache-openjpa-1.0.1/docs/ /www/openjpa.apache.org/docs/latest

Then point the links on http://openjpa.apache.org/documentation.html to:

• HTML Manual: http://openjpa.apache.org/builds/1.0.1/apache-openjpa-1.0.1/docs/manual/index.html
  
• HTML Manual (single-page): http://openjpa.apache.org/builds/1.0.1/apache-openjpa-1.0.1/docs/manual/manual.html
  
• PDF Manual: http://openjpa.apache.org/builds/1.0.1/apache-openjpa-1.0.1/docs/manual/manual.pdf
  
• Javadocs: http://openjpa.apache.org/builds/1.0.1/apache-openjpa-1.0.1/docs/javadoc/index.html
  

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

svn co http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-stage-plugin/ \
    /tmp/maven-stage-plugin
mvn -f /tmp/maven-stage-plugin/pom.xml clean install
for i in $(find openjpa-* -name m2-repository | egrep -v "openjpa-project|openjpa-integration|openjpa-examples"); do
    cd $i
    mvn stage:copy -Dsource=file://. \
    -Dtarget=scp://people.apache.org:/www/people.apache.org/repo/m2-ibiblio-rsync-repository \
    -Dversion=1.0.1
    cd -
done

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.

After the mirrors have had time to update (24 hours to be on the safe side), make a news announcement on the OpenJPA wiki.

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.

Make an announcement for the freshmeat.net OpenJPA project (optional)

Have a beer and enjoy your weekend while the world's grateful programmers revel in yet another high-quality release of Apache OpenJPA!

Install PuTTY

Use ssh-keygen to create a SSH key.

In Windows platform, use PuttyGen to create a SSH key (see Putty help for details).

pscp your SSH public key authorized_keys saved in last step to ~/authorized_keys

Use PuTTY to login to people.apache.org

Create a ~\.ssh folder and change its file mode to 700.

Move or append ~/authorized_keys to ~/.ssh/authorized_keys and change its file mode to 600.

Configure putty to use your private key and save the session

Install cgywin, including Utils/gnupg and Net/openssh packages, or install gpg from http://www.gnupg.org/(en)/download/index.html

Generate a key-pair with $ gpg --gen-key using default key kind ("DSA and Elgamal") and ELG-E keys size (2048).

Backup your cygwin home directory to another media

Add your public key to https://svn.apache.org/repos/asf/openjpa/site/docs/KEYS and /www/www.apache.org/dist/openjpa/KEYS. 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.

Following the instructions in http://people.apache.org/~henkp/trust/ and ask someone in the OpenJPA project to sign your public key.

Submit your public key to a key server. E.g. http://pgp.surfnet.nl:11371/ or http://pgp.mit.edu/

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

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)

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

Copy the known_hosts file to the new .ssh folder

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:

revision.number=Type 'svnversion --help' for usage.
openjpa.version=1.0.1

Rename the path and remove all spaces.

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:

• Use absolute path in the find command's root directory.
  Problem symptom:

  Code Block

  $ find . -name m2-repository -not -path "*openjpa-project*" \ -exec mvn -f "c:/tmp/maven-stage-plugin/pom.xml" stage:copy \ -Dsource=file://{} -Dtarget=scp://allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository \ -Dversion=1.0.1 \; [INFO] Scanning for projects... [INFO] Searching repository for plugin with prefix: 'stage'. ........ [INFO] Downloading file from the source repository: [INFO] ------------------------------------------------------------------------ [ERROR] BUILD ERROR [INFO] ------------------------------------------------------------------------ [INFO] Error copying repository from file://./openjpa-all/target/site/m2-repository to \ scp://allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository

• Quote and use the drive name in the path.
  Problem symptom:

  Code Block

  $ find /cygdrive/c/OpenJPA.1.0.1.Release/1.0.1 -name m2-repository -not -path "*openjpa-project*" \ -exec mvn -f /cygwin/c/tmp/maven-stage-plugin/pom.xml stage:copy \ -Dsource=file://{} -Dtarget=scp://allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository \ -Dversion=1.0.1 \; [INFO] Scanning for projects... [INFO] Searching repository for plugin with prefix: 'stage'. ........ [INFO] Downloading file from the source repository: [INFO] ------------------------------------------------------------------------ [ERROR] BUILD ERROR [INFO] ------------------------------------------------------------------------ [INFO] Error copying repository from file:///cygdrive/c/OpenJPA.1.0.1.Release/1.0.1/openjpa-all/target/site/m2-repository to scp://allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository 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.)

• Specify the people.apache.org user id in the target property.
  Problem symptom:

  Code Block

  $ find "c:/OpenJPA.1.0.1.Release/1.0.1" -name m2-repository -not -path "*openjpa-project*" \ -exec mvn -f "c:/tmp/maven-stage-plugin/pom.xml" stage:copy -Dsource=file://{} -Dtarget=scp://people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository \ -Dversion=1.0.1 \; [INFO] Scanning for projects... [INFO] Searching repository for 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://c:/OpenJPA.1.0.1.Release/1.0.1/openjpa-all/target/site/m2-repository to \ scp://people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository

As recommended in the descriptions.

find "c:/OpenJPA.1.0.1.Release/1.0.1" -name m2-repository -not -path "*openjpa-project*" \
    -exec mvn -f "c:/tmp/maven-stage-plugin/pom.xml" stage:copy \
    -Dsource=file://{} \
    -Dtarget=scp://allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository \
    -Dversion=1.0.1 \;

For Cygwin/Windows user: file and folder path names using drive identifier (e.g. C:\OpenJPA Release\1.0.1 ) in commands can be expressed as /cygwin/c/OpenJPA Release/1.0.1/. This form of path name specification may have inconsistent and undesirable behaviors.

Consistently use the following naming conventions:

• Continue to use the Windows form of path name, e.g. C:\a\b\c
• Use '/' instead of '\' character as file separator, e.g. C:/a/b/c
• Quote all path name using '"' character, e.g. "C:/a/b/c"
• Avoid using space characters in path name, e.g. "C:/OpenJPA.Release/1.0.1"

Encounter the "Too many unapproved licenses:" message while running the "license-verify-profile" profile in "mvn deploy site..." step. This is caused by extra artifacts in the build tree that the license verification plugin does not recognized. Examples of these artifacts are:

1. Eclipse control files, .classpath, .project
2. User created log files

Avoid the followings:

1. 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.
2. Don't create, directly or indirectly, any files under the release build tree.