Page History

Make sure the #One time setup steps have been performed

Run the Release Audit Tool

1. Download the latest rat jar.
2. run

   Code Block
   none none
   java -jar ${pathToRat.jar} ${directoryContainingOpenJPA} > rat.output.txt

   . In general it's a good idea to keep rat.output.txt outside of the code tree for OpenJPA so that it isn't included in the distribution.
3. Look through rat.output.txt for any files that are missing headers. The output will look something like this
   

   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

   Look for !????? files. A complete file can be found here.
   As you can see from the example there are some files which do not have license headers. This will be addressed in a future release. Until that time you'll need to evaluate each file on a case by case basis. If you find source code or files which do not have the appropriate headers you should add the header and commit the changes back to trunk.
   

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.
  Changes made to any of these files should also be made to trunk.
  

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:

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

Commit the POM changes

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

Verify the signatures:

Now actually build the javadocs and perform the deploy upload using the release profile from settings.xml. This will deploy to a staging directory on people.apache.org instead of deploying to the official incubating repository.

Tag the branch with the release number:

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

Commit the POM changes

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

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.

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

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:

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

You can now move the jars from the staging directory on people.apache.org to the incubator repository.
This can be done via the maven-staging-plugin. An early version of this plugin is available in svn.

 svn co http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-stage-plugin/ maven-stage-plugin 
cd maven-stage-plugin
mvn clean install
mvn stage:copy -Dsource="http://people.apache.org/~mikedd/public_html/staging-repository/" \
   -Dtarget="scp://people.apache.org/www/people.apache.org/repo/m2-incubating-repository/" \
   -Dversion=0.9.7-incubating 
## This last step may take some time.