Skip to content

Latest commit

 

History

History
117 lines (79 loc) · 3.39 KB

RELEASE_STEPS.md

File metadata and controls

117 lines (79 loc) · 3.39 KB
Raw

How to release Jdbi

Prerequisites

You have followed the steps on https://central.sonatype.org/pages/ossrh-guide.html to set up your Sonatype account, and have uploaded your GNUPG key to the key server at http://pool.sks-keyservers.net/

Create a release branch off of the latest master

Name it jdbi-<version>-release.

Example:

$ git clone git@github.com:jdbi/jdbi
$ cd jdbi
$ git checkout -b jdbi-<version>-release master

or

$ cd jdbi
$ git pull
$ git checkout -b jdbi-<version>-release master

Update release notes

Double check that release notes contain all the most important changes for the release.

Build the release on your workstation

Create the release artifacts in Maven, and deploy them to Sonatype staging repository. Use the latest Java LTS version (currently 17) to build the artifacts.

$ ./mvnw release:prepare release:perform

Change the release version if needed, or just press Enter if the suggested version is good.

Accept the release tag and snapshot versions suggested by Maven.

Grab a coffee. A release build takes about six minutes on a reasonably current laptop.

If the release succeeds, there will be two new commits on the branch:

  • a release commit with the release version
  • a snapshot commit with the next snapshot version

It also creates a release tag, pointing to the release commit.

Publish the release to Central in oss.sonatype.org

  • Open oss.sonatype.org and log in
  • Click Staging Repositories
  • Search for jdbi (top right corner)
  • Select the repository and click Close
    • Closing the repository means closing it for further modification
    • Nexus will check that all files uploaded to the staging repository meet Maven Central publishing requirements
  • Click Refresh until the repository status changes to "closed"
    • If this fails, find out what rule was not satisfied, and start over! Yay!
  • Click Release to submit the release to Maven Central.
    • Type in something to the description like "Jdbi release v<version>"
  • Click Refresh until the repository status changes again, which will make it disappear from the search.

Release code changes to github

Push release release branch and tag to Github, then merge the release branch back to the master:

$ git push -u origin jdbi-<version>-release
$ git push --tags
$ git checkout master
$ git merge --ff-only jdbi-<version>-release
$ git push master

Publish the docs

Check out the release tag from Git, and run the publish-docs.sh script to send doc updates to jdbi.org:

$ git checkout v<version>
$ ./docs/publish-docs.sh

Add a release announcement to github

  • open https://github.com/jdbi/jdbi, click on "Releases"
  • "Draft a new Release"
  • Select the just pushed Tag, use Release title "JDBI <version>"
  • paste the line items from the Release notes into the "Describe this release" text box
  • Click "Publish release"

Publish release announcement to the mailing list

Write up a release announcement (similar to past announcements on the mailing list) and hit Send

Include in the message:

  • The new version
  • A link to the new artifacts on Maven Central
  • The release notes since the last announcement

Send it to the mailing list: jdbi@googlegroups.com

Additional Modules

A small number of JDBI3 modules is maintained outside the main build. Consider releasing those as well: