Release Guide 2.0 has been edited by Andrus Adamchik (May 07, 2007).

(View changes)


Note that this page is of use for committers only. It describes the general procedure of building a Cayenne release.



Refer to the Prerequisites section of the main release guide

Preparing Sources

  • Create a report in Jira listing all issues that are FIXED but not CLOSED, paste its contents to RELEASE-NOTES.txt. Bulk-close all involved issues. Note that issues that affect multiple releases are usually closed immediately when they are fixed, and the note is placed in RELEASE-NOTES.txt immediately when this happens.
  • Edit UPGRADE-NOTES.txt if there is anything to add there.
  • Check Sources Compliance with ARAT. ARAT (A Release Audit Tool) is a Java tool written by Robert Burrell Donkin for checking the release files for ASF licensing compliance. To run ARAT, check it out of SVN (we are using version 0.4), build with Ant, and run against unpacked distro (or the release tag), read the report and fix any issues.
java -jar rat-0.4.jar /path/to/cayenne > report.txt

Building Release Artifacts

  • Tag cayenne directory under the repository trunk (assuming [CAY:release_version] is a version tag identifying the release, such as "1.2B3"):
svn mkdir[CAY:release_version] -m "[CAY:release_version] tag dir"
svn copy \[CAY:release_version]/cayenne -m "tagging B3 release"
  • Export the new tag to some directory on the build machine:
svn export[CAY:release_version]/cayenne
  • Note that all Ant commands now must contain "project.version" property corresponding to the release version. The property is passed on the command line as "-Dproject.version=2.0.x". See examples below.
  • Run a test to make sure the checkout is ok:
ant test -Dproject.version=2.0.x

Test with all supported databases listed here, or at least as many as possible. See Legacy Ant Unit Tests for more details on how to test each of the various database servers with legacy versions of Cayenne.

  • Build a release for the target platform:
ant release -Dproject.version=2.0.x
ant release-win -Dproject.version=2.0.x
ant release-mac -Dproject.version=2.0.x
  • Build Release Maven Bundles for ibiblio upload:
ant mvn-bundle -Dproject.version=2.0.x
  • Signing release

For more info visit this page. Release manager key must be in the project KEYS file. Signing is a manual procedure not included in the Ant or Maven script. Here is how it might work ("-u" option can be omitted if you have only one GPG key):

gpg --armor -u B8AF90BF --output cayenne-2.0-SNAPSHOT.tar.gz.asc --detach-sig cayenne-2.0-SNAPSHOT.tar.gz


Refer to the Voting section of the main release guide

Publishing the Release


Copy KEYS file if updated to "/www/"

(TODO: automate publishing the keys - maybe create a "dist" site project?)

cp ~/public_html/.../* /www/
chmod 664 /www/

Publishing Maven Artifacts

(TODO: automate rsync with Ant)

Assuming release version is 2.0.2, on a local machine do

cd cayenne-ant
ant clean mvn-install -Dproject.version=2.0.2
rsync -azv ~/.m2/repository/org/apache/cayenne/cayenne-nodeps/2.0.2
rsync -azv ~/.m2/repository/org/apache/cayenne/cayenne/2.0.2
rsync -azv ~/.m2/repository/org/apache/cayenne/cayenne-client-nodeps/2.0.2
rsync -azv ~/.m2/repository/org/apache/cayenne/cayenne-modeler/2.0.2

After the release

  • Update the DOAP file (held in the Cayenne svn) which will update automatically
  • Update Freshmeat with new release number (
  • If the release is significant, consider press releases to relevant news sources
  • Review the main website pages (front page and why-cayenne especially) to add any new features
  • Add a news item to the Cayenne web site
  • Send an email to the Cayenne user and developer lists

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

Unsubscribe or edit your notifications preferences