Release Guide has been edited by Andrus Adamchik (Jul 15, 2007).

(View changes)

Content:

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

Guide FOR 3.0 RELEASE BRANCH

Prerequisites

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, download the jar (we are using version 0.5.1), and run it against unpacked distro (or the release tag), read the report and fix any issues.
java -jar rat-0.5.1.jar /path/to/cayenne > report.txt

Building Release Artifacts

  • Tag cayenne directory under the repository trunk (assuming X.X is a version tag identifying the release, such as "1.2B3"):
svn mkdir https://svn.apache.org/repos/asf/cayenne/main/tags/X.X -m "X.X tag dir"
svn copy https://svn.apache.org/repos/asf/cayenne/main/trunk \
   https://svn.apache.org/repos/asf/cayenne/main/tags/X.X/cayenne -m "tagging X.X release"
  • Export the new tag to some directory on the build machine:
svn export https://svn.apache.org/repos/asf/cayenne/main/tags/X.X/cayenne
  • TODO: build with Maven
  • 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-X.X.tar.gz.asc --detach-sig cayenne-X.X.tar.gz

Voting

  • Release files are uploaded to the release manager's web directory on people.apache.org.
  • The vote is started on cayenne-dev mailing list.

Publishing the Release

TODO build release with Maven

After the release

  • Update the DOAP file (held in the Cayenne svn) which will update http://projects.apache.org/projects/cayenne.html automatically
  • Update Freshmeat with new release number (http://freshmeat.net/projects/cayenne/)
  • 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

Reference:

Reply via email to