Release checklist for Hibernate developers

Follow these steps to release a Hibernate package:

Prepare and tag

1. Get the changelog (text version) from JIRA and paste it into changelog.txt, check the release date (format dd/mm/yyyy) and version, commit.
2. Mark version as released in JIRA along with release date.
3. Check the release date and version in the following files and commit:
   • readme.txt
   • build.xml
   • pom.xml
   • /doc/reference/en/master.xml
   • Environment.java or Version.java
4. Create the SVN tag for the release.
5. Get an export for the tag from SVN. Honour the naming standards!

Build dist

1. Build dist
   • Non annotation based projects run (using JDK 1.4): ant dist
   • Annotation based projects using run (JDK 1.5): ant clean junit then ant clean dist
2. Check the presence of all files by browsing through the created distribution. Check documentation. Check the lib directory and its readme file.
3. Run the "eg" example as a final check.

Publish

SourceForge

1. Upload the packages to sftp://frs.sourceforge.net/uploads/ using your sourceforge login and password.
2. Log into SourceForge and create a new release:
   • Choose Admin->File Releases
   • Select Add Release for the package you want to release and use the version number as release name
   • Paste in the readme.txt and changelog. Update. You cannot fill out the whole form in one go!
   • Attach the dist packages. Update!
   • Update file information. Update
   • Notify users.

hibernate.org

1. Update the documentation. GA releases only! From the doc directory of your distribution run:

> scp -r ./api <user>@hibernate.org:/www/www.hibernate.org/htdocs/hib_docs/<package>/api
> scp -r ./reference <user>@hibernate.org:/www/www.hibernate.org/htdocs/hib_docs/<package>/reference
> ssh <user>@hibernate.org
> cd /www/www.hibernate.org/htdocs/hib_docs/<package>
> chmod -R g+w
> chgrp -R hbnate

1. Verify that all permissions are correct. Everything has to be group writable for hbnate.
2. Update version number and release data on http://www.hibernate.org/397.html (GA releases only).
3. Update version number and check links on http://www.hibernate.org/5.html (GA releases only).
4. Update version numbers and check matrix on http://www.hibernate.org/6.html.

Jboss repository

1. Non annotation based projects: Create release component within JBoss repo http://repository.jboss.com/hibernate/
2. Annotation based projects:
   • Get a local checkout of https://svn.jboss.org/repos/repository.jboss.org/maven2
   • Run ant clean deploy -Doffline.repository.jboss.org=<directory of repo checkout>
   • Commit

Announce

1. Blog on In Relation To
2. Announce on forum, developer list, and front page with a list of most important changes.