how-to-release.md

Releasing Hibernate OGM

Requirements

Make sure you have:

1. JDK 8 for the build (the created artifacts are compatible with Java 7)

2. Maven

3. all the permissions required to perform the release process:

• CI
• Nexus: you can try to login on the Nexus web interface

Release process

To prepare and release a new version of Hibernate OGM follow these steps (executed against the branch you intend to release):

Preparation

Verify:

1. the project status on Jenkins

2. the latest version of Hibernate ORM is used

3. there are no outstanding issues in JIRA

4. tests and artifacts:

       mvn clean install -s settings-example.xml
   

5. the distribution package as built by Maven (distribution/target/hibernate-ogm-[version]-dist).

   They should contain the appropriate dependencies, without duplicates. The creation of these directories is driven by the assembly plugin (see distribution/src/main/assembly/dist.xml) which is very specific and might break with the inclusion of new dependencies.

   Especially check the jar files in the subdirectories:

   • optional
   • required
   • provided

Release

1. Release the version on JIRA

2. Do NOT update changelog.txt in project root: it will be automatically updated

3. Verify readme.txt:

   • content is up to date
   • links are not broken
   • don't change the version number, it will be automatically updated

4. Commit any outstanding changes

5. Go to CI and execute the release job.

   • Be careful when filling the form with the build parameters.

6. Log in to Nexus:

   • check all artifacts you expect are there
   • close and release the repository. See more details about using the staging repository
   • if there is a problem, drop the staging repo, fix the problem and re-deploy

Publish

1. The CI job automatically pushes the distribution to SourceForge and publishes the documentation to docs.jboss.org.

2. Update the community pages. In particular, update the migration notes. When doing the latter, create an API change report by running mvn clirr:clirr -pl core. The report created at core/target/site/clirr-report.html provides an overview of all changed API/SPI types. After you have created the change log, don't forget to update the comparisonVersion in the configuration of the Maven Clirr plug-in in pom.xml.

Announce

1. Blog about the release on in.relation.to, make sure to use the tags Hibernate OGM, Hibernate and news for the blog entry. This way the blog will be featured on the web-site and on the JBoss blog federation.

2. Update hibernate.org by adding a new release file to data/projects/ogm/releases and by updating the roadmap in ogm/roadmap.adoc Remember to add a one line summary using the property summary. If you don't want to display an older release, set the property displayed to false in the corresponding .yml file.

3. Check the getting started guide on the website. It is mostly copied from the reference documentation with a few twists. Likewise, check the roadmap, move the new released to the previous section and adjust the roadmap as needed. When ready, deploy everything on production.

   Check:

   • http://www.hibernate.org/ogm/download
   • http://www.hibernate.org/ogm/documentation
   • http://www.hibernate.org/ogm/roadmap

4. Update the sticky post in the forum: https://forum.hibernate.org/viewtopic.php?f=31&t=1037570

5. Send email to hibernate-dev and hibernate-announce. A quick sum up paragraph in the email is necessary before pointing to the blog entry.

6. Twitter