OpenJPA Logo   ASF Logo

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.


  1. You should read the OpenJPA Release Policy to decide on the name of the new release, based on the content.
  2. You should read the Apache Release FAQ
  3. You must have shell access to
  4. You must have the following utilities installed on your local machine and available in your path:
  5. 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

{info}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.{info}

{code:none} svn copy -m "OpenJPA Release 1.0.1 branch" \ \

|| Monday, 12:02 | Check out a clean branch from which to build the

release: \ {code:none} svn checkout cd 1.0.1

{note}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 "{note} ||

{code:none} perl -pi -e "s;1.0.1-SNAPSHOT;1.0.1;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 {{}} element in the top level pom.xml if new committers are added or removed. This applies to the 1.0.x branch only. || || Monday, 12:10 | 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. \ || || Monday, 12:15 | 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.\ || || Monday, 12:20 | Commit the POM changes \ {code:none} svn commit -m "Updated to version 1.0.1 for the release"

{code:none} mvn clean install -Dtest=false

|| 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. \ {code:none} 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 \${HOME}/.m2/privaterepos/

{note} The examples-profile has problem running automatically in this maven build task. You will need to run the examples manually. Run the maven command without the examples-profile, then perform the following steps to run the example:

mkdir openjpa-integration\examples\target\examples
unzip target\site\downloads\ -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

{note} ||

{code:none} gpg --multifile --verify target/site/downloads/*.asc

|| Monday, 13:01 | Upload the release candidate to []
\ {code:none} mvn site:deploy

Bear in mind that uploads to are not visible at until after the hourly synchronization has taken place, as described at [] . {warning}||

{code:none} ssh cp -r /www/* /www/ chgrp -R openjpa /www/ chmod -R g+w /www/

The OpenJPA binary release will be available via the link []

after 24 hours, as per the [Apache mirroring information|] . {warning}|| || Thursday, 15:15 | Now that the release is locked down, convert the writeable 1.0.1 branch to a (du jure) read-only tag: \ {code:none} svn mv -m "OpenJPA Release 1.0.1 tag" \ \

{code:none} svn checkout cd 1.0.x perl -pi -e "s;1.0.1-SNAPSHOT;1.0.2-SNAPSHOT;g" \ pom.xml /pom.xml /*/pom.xml svn commit -m "Updating version in branch to 1.0.2-SNAPSHOT"

|| Thursday, 15:20 | Update the []

page with links to the download mirrors, using the existing entries as templates. {note}All artifacts ( and must link to the mirrors, but signatures ( and must not link to mirrors.{note}|| || Thursday, 15:30 | The documentation on the server-side must manually be extracted on, and the links at [] need to be updated with the new versions and the "latest" documentation symbolic links need to be updated: \ {code:none} cd /www/ unzip downloads/ rm /www/ ln -fvs ../builds/1.0.1/apache-openjpa-1.0.1/docs/ /www/

Monday, 15:00 Start a vote for the release on the 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.
{code:none} svn co \ /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:// \ -Dversion=1.0.1 cd - done 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. {warning} {info} Window/Cygwin user: See [#Merging local repository to remote repository in Cygwin/Windows] {info} {info} 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." {info} || 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. {note}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).{note} || || Friday, 16:05 | Make an announcement about the release on the [] list (and, for major releases, on the [] list as per [the Apache Announcement Mailing Lists page|] ). The announcement might look something like [this|] . || || Friday, 16:10 | Make an announcement for the [ 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! || h2. 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 {info} h3. Create and install a SSH key || 1 | Install PuTTY || || 2a | Use ssh-keygen to create a SSH key. {info} See [Authenticating By Public Key (OpenSSH)|] for a good description on why and how to perform this task. {info} || || 2b | In Windows platform, use PuttyGen to create a SSH key (see Putty help for details). {info} * Use "*SSH-2 DSA*" key type and *1024*-bit key size. * Copy the content of the "Public key for pasting...." and save it to a file named {{authorized_keys}} for later use. * The private key saved by PuTTYGen can only be used in Putty configuration. {info} || || 3 | {{pscp}} your SSH public key {{authorized_keys}} saved in last step to {{\~/authorized_keys}} || || 4 | Use PuTTY to login to || || 5 | Create a {{\~\.ssh}} folder and change its file mode to 700. || 6 | Move or append {{\~/authorized_keys}} to {{\~/.ssh/authorized_keys}} and change its file mode to 600. {info} * Each public key in the {{authorized_keys}} spans only one line. ** For example: "{{ssh-dss AAAAB3NzaC1kc3MAAA ..... agBmmfZ9uAbSqA== dsa-key-20071107}}" * '#' in the first column is a comment line. {info} || || 7 | Configure putty to use your private key and save the session {info} Specify your private key in the "Connection -> SSH -> Auth" category in Putty configuration. {info} || h3. Create a PGP key || 1 | Install cgywin, including *Utils/gnupg* and *Net/openssh* packages, or install gpg from {{[] }} || || 2 | Generate a key-pair with {{$ gpg \--gen-key}} using default key kind ("DSA and Elgamal") and ELG-E keys size (2048). {info} * The generated keys are stored in $HOME/.gnupg or %HOME%\Application Data\gnupg subdirectory. * Save the content in this subdirectory to a safe media. This contains your private key used to sign all the OpenJPA release materials. {info} || || 3 | Backup your cygwin home directory to another media || || 4 | Add your public key to {{[] }} and {{/www/}}. 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. || || 5 | Following the instructions in [] and ask someone in the OpenJPA project to sign your public key. || || 6 | Submit your public key to a key server. E.g. [] or [] || h3. Update Maven settings for our servers || 1 | Create a settings.xml under .m2 (in your Document and Settings folder in Windows) || | | {code:xml|title=settings.xml|borderStyle=solid} $USERNAME $PATH_TO_PRIVATE_KEY 775 644 {info} *$PATH_TO_PRIVATE_KEY* is the path to the private key generated for ssh. E.g. /home/yourLocalUserId/.ssh/id_dsa. {info} | ### 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
## Troubleshooting ### Space Character in Build Root Path|borderStyle=solid
revision.number=Type 'svnversion --help' for usage. openjpa.version=1.0.1
Description If there are spaces in the path to the build root subdirectory, the maven task uses to generate the revision number for the yields incorrect data. For example:
Solution Rename the path and remove all spaces.
### Merging local repository to remote repository in Cygwin/Windows Problem symptom: $ find . -name m2-repository -not -path "*openjpa-project*" \ -exec mvn -f "c:/tmp/maven-stage-plugin/pom.xml" stage:copy \ -Dsource=file://{} -Dtarget=scp:// \ -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:// * Quote and use the drive name in the path. Problem symptom: $ 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:// \ -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:// 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 user id in the target property. Problem symptom: $ 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:// \ -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://
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:
{note}For example: 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:// \ -Dversion=1.0.1 \; ### Cygwin/Windows File Path
Solution As recommended in the descriptions.
* 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*" ||
Description 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.
Solution Consistently use the following naming conventions:
### "Too many unapproved licenses:" 1. Eclipse control files, .classpath, .project 1. User created log files || 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. 1. Don't create, directly or indirectly, any files under the release build tree. ||
Description 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:
Solution Avoid the followings:
## Resources * Apache Apache [Release FAQ]( * [Signing Releases]( * [Wendy's notes on Release Signing]( * Apache [Mirroring Guidelines]( * Struts [Release Instructions]( (upon which these instructions are based)
Copyright © 2006,2020 The Apache Software Foundation. Licensed under Apache License 2.0.
Apache, the Apache feather logo and OpenJPA are trademarks of The Apache Software Foundation.
Other names may be trademarks of their respective owners.