ORM Releases

Table of Contents

• Preparation
  • New Series
• Perform the Release
  • Release Artifacts (jar)
  • Gradle Plugin
  • Documentation
• Announce

This module performs the tasks needed as part of creating a release for Hibernate ORM. Releases are triggered as a Jenkins job.

Preparation

There are a few steps that need to be performed prior to starting the release job:

1. Pull all upstream changes and perform ./gradlew preVerifyRelease.

2. Verify issues in the Jira version

   1. Remove fix version for anything rejected, etc.

   2. Move unresolved issues to another version

3. Mark version released in Jira

4. Bulk close all issues in the Jira version

New Series

If this is a new series, some additional steps are required to prepare the website:

1. Create the series descriptor

   1. create the directory _data/projects/orm/releases/${family_name}

   2. create the file series.yml

   3. add the appropriate content (generally this can be copied from previous series)

2. Create the series listing

   1. create the directory orm/releases/${family_name}

   2. create the file index.adoc

   3. add listing of all new features in the series

3. Create the documentation listing

   1. create the directory orm/documentation/${family_name}

   2. create the file index.adoc

   3. add links to all documentation (generally this can be copied from previous series)

4. If this new series is to support a new JPA release, also be sure to update orm/releases/index.adoc

Perform the Release

Start the appropriate Jenkins job.

Note	When a release is started, the job coordinates with the unified Hibernate release scripts in a number of stages and steps, calling tasks on this module’s Gradle script.

At a high-level, this process:

• builds and verifies the individual modules

• produces artifacts and publishes them

• tags the release

• updates the website

This process has a number of "outputs"…​

Release Artifacts (jar)

Release artifacts are published to Sonatype OSSRH (aka, Maven Central). For each module, we publish:

• The "main" jar

• The sources jar

• The javadoc jar

Gradle Plugin

The Gradle plugin gets published to Gradle’s Plugin Portal.

See https://plugins.gradle.org/plugin/org.hibernate.orm

Documentation

All documentation for the release is generated, assembled and then published to the documentation server.

Announce

If the release is a maintenance release, there is nothing more to do.

However, for Alpha, Beta, CR and first Final releases some announcements are in order:

1. Write a release announcement blog post.

2. Announce the release, with link to the blob post:

   1. on the hibernate-dev and hibernate-announce mailing lists

   2. on the forums

   3. on Twitter

   4. anywhere else you wish (BlueSky, etc).