Release Guide

Introduction

The Apache Kyuubi project periodically declares and publishes releases. A release is one or more packages of the project artifact(s) that are approved for general public distribution and use. They may come with various degrees of caveat regarding their perceived quality and potential for change, such as “alpha”, “beta”, “incubating”, “stable”, etc.

The Kyuubi community treats releases with great importance. They are a public face of the project and most users interact with the project only through the releases. Releases are signed off by the entire Kyuubi community in a public vote.

Each release is executed by a Release Manager, who is selected among the Kyuubi committers. This document describes the process that the Release Manager follows to perform a release. Any changes to this process should be discussed and adopted on the dev mailing list.

Please remember that publishing software has legal consequences. This guide complements the foundation-wide Product Release Policy and Release Distribution Policy.

Overview

The release process consists of several steps:

  1. Decide to release
  2. Prepare for the release
  3. Cut branch off for feature release
  4. Build a release candidate
  5. Vote on the release candidate
  6. If necessary, fix any issues and go back to step 3.
  7. Finalize the release
  8. Promote the release
  9. Remove the dist repo directories for deprecated release candidates
  10. Publish docker image

Decide to release

Deciding to release and selecting a Release Manager is the first step of the release process. This is a consensus-based decision of the entire community.

Anybody can propose a release on the dev mailing list, giving a solid argument and nominating a committer as the Release Manager (including themselves). There’s no formal process, no vote requirements, and no timing requirements. Any objections should be resolved by consensus before starting the release.

In general, the community prefers to have a rotating set of 1-2 Release Managers. Keeping a small core set of managers allows enough people to build expertise in this area and improve processes over time, without Release Managers needing to re-learn the processes for each release. That said, if you are a committer interested in serving the community in this way, please reach out to the community on the dev mailing list.

Checklist to proceed to the next step

  1. Community agrees to release
  2. Community selects a Release Manager

Prepare for the release

Before your first release, you should perform one-time configuration steps. This will set up your security keys for signing the release and access to various release repositories.

One-time setup instructions

ASF authentication

The environments ASF_USERNAME and ASF_PASSWORD have been used in several places and several times in the release process, you can either one-time set up them in ~/.bashrc or ~/.zshrc, or export them in terminal every time.

export ASF_USERNAME=<your apache username>
export ASF_PASSWORD=<your apache password>

Java Home

An available environment variable JAVA_HOME, you can do echo $JAVA_HOME to check it. Note that, the Java 17 or 21 is required since 1.11.0, for earlier versions, it requires Java 8.

Subversion

Besides on git, svn is also required for Apache release, please refer to https://www.apache.org/dev/version-control.html#https-svn for details.

GPG Key

You need to have a GPG key to sign the release artifacts. Please be aware of the ASF-wide release signing guidelines. If you don’t have a GPG key associated with your Apache account, please create one according to the guidelines.

Determine your Apache GPG Key and Key ID, as follows:

gpg --list-keys --keyid-format SHORT

This will list your GPG keys. One of these should reflect your Apache account, for example:

pub   rsa4096 2021-08-30 [SC]
      8FC8075E1FDC303276C676EE8001952629BCC75D
uid           [ultimate] Cheng Pan <chengpan@apache.org>
sub   rsa4096 2021-08-30 [E]

Note: To follow the Apache's release specification, all new RSA keys generated should be at least 4096 bits. Do not generate new DSA keys.

Here, the key ID is the 8-digit hex string in the pub line: 29BCC75D.

To export the PGP public key, using:

gpg --armor --export 29BCC75D

If you have more than one gpg key, you can specify the default key as the following:

echo 'default-key <key-fpr>' > ~/.gnupg/gpg.conf

The last step is to update the KEYS file with your code signing key https://www.apache.org/dev/openpgp.html#export-public-key

svn checkout --depth=files "https://dist.apache.org/repos/dist/release/kyuubi" work/svn-kyuubi

(gpg --list-sigs "${ASF_USERNAME}@apache.org" && gpg --export --armor "${ASF_USERNAME}@apache.org") >> work/svn-kyuubi/KEYS

svn commit --username "${ASF_USERNAME}" --password "${ASF_PASSWORD}" --message "Update KEYS" work/svn-kyuubi

In order to make yourself have the right permission to stage java artifacts in Apache Nexus staging repository, please submit your GPG public key to ubuntu server via

gpg --keyserver hkp://keyserver.ubuntu.com --send-keys ${PUBLIC_KEY} # send public key to ubuntu server
gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys ${PUBLIC_KEY} # verify

Cut branch if for feature release

Kyuubi use version pattern {MAJOR_VERSION}.{MINOR_VERSION}.{PATCH_VERSION}[-{OPTIONAL_SUFFIX}], e.g. 1.7.0. Feature Release means MAJOR_VERSION or MINOR_VERSION changed, and Patch Release means PATCH_VERSION changed.

The main step towards preparing a feature release is to create a release branch. This is done via standard Git branching mechanism and should be announced to the community once the branch is created.

Note: If you are releasing a patch version, you can ignore this step.

The release branch pattern is branch-{MAJOR_VERSION}.{MINOR_VERSION}, e.g. branch-1.7.

After cutting release branch, don't forget bump version in master branch.

Build a release candidate

Don't forget to switch to the release branch!

  • Set environment variables.
export RELEASE_VERSION=<release version, e.g. 1.7.0>
export RELEASE_RC_NO=<RC number, e.g. 0>
export NEXT_VERSION=<e.g. 1.7.1>
  • Bump version, and create a git tag for the release candidate.

Considering that other committers may merge PRs during your release period, you should accomplish the version change first, and then come back to the release candidate tag to continue the rest release process.

The tag pattern is v${RELEASE_VERSION}-rc${RELEASE_RC_NO}, e.g. v1.7.0-rc0

NOTE: After all the voting passed, be sure to create a final tag with the pattern: v${RELEASE_VERSION}

# Bump to the release version
build/mvn versions:set -DgenerateBackupPoms=false -DnewVersion="${RELEASE_VERSION}"
(cd kyuubi-server/web-ui && npm version "${RELEASE_VERSION}")
git commit -am "[RELEASE] Bump ${RELEASE_VERSION}"

# Create tag
git tag v${RELEASE_VERSION}-rc${RELEASE_RC_NO}

# Prepare for the next development version
build/mvn versions:set -DgenerateBackupPoms=false -DnewVersion="${NEXT_VERSION}-SNAPSHOT"
(cd kyuubi-server/web-ui && npm version "${NEXT_VERSION}-SNAPSHOT")
git commit -am "[RELEASE] Bump ${NEXT_VERSION}-SNAPSHOT"

# Push branch to apache remote repo
git push apache

# Push tag to apache remote repo
git push apache v${RELEASE_VERSION}-rc${RELEASE_RC_NO}

# Go back to release candidate tag 
git checkout v${RELEASE_VERSION}-rc${RELEASE_RC_NO}
  • Package source and binary artifacts, and upload them to the Apache staging SVN repo. Publish jars to the Apache staging Maven repo.
build/release/release.sh publish

To make your release available in the staging repository, you must close the staging repo in the Apache Nexus. Until you close, you can re-run deploying to staging multiple times. But once closed, it will create a new staging repo. So ensure you close this, so that the next RC (if need be) is on a new repo. Once everything is good, close the staging repository on Apache Nexus.

  • Generate a pre-release note from GitHub for the subsequent voting.

Goto the release page and click the “Draft a new release” button, then it would jump to a new page to prepare the release.

Filling in all the necessary information required by the form. And in the bottom of the form, choose the “This is a pre-release” checkbox. Finally, click the “Publish release” button to finish the step.

Note: the pre-release note is used for voting purposes. It would be marked with a Pre-release tag. After all the voting works(dev and general) are finished, do not forget to inverse the “This is a pre-release” checkbox. The pre-release version comes from vx.y.z-rcN tags, and the final version should come from vx.y.z tags.

Vote on the release candidate

The release voting takes place on the Apache Kyuubi developers list.

  • If possible, attach a draft of the release notes with the email.
  • Recommend represent voting closing time in UTC format.
  • Make sure the email is in text format and the links are correct.

Note: you can generate the voting mail content for dev ML automatically via invoke the build/release/script/dev_kyuubi_vote.sh script.

Once the vote is done, you should also send out a summary email with the totals, with a subject that looks something like [VOTE][RESULT] Release Apache Kyuubi ...

Finalize the Release

Be Careful!

THIS STEP IS IRREVERSIBLE so make sure you selected the correct staging repository. Once you move the artifacts into the release folder, they cannot be removed.

After the vote passes, to upload the binaries to Apache mirrors, you move the binaries from dev directory (this should be where they are voted) to release directory. This “moving” is the only way you can add stuff to the actual release directory. (Note: only PMC members can move to release directory)

Move the subdirectory in “dev” to the corresponding directory in “release”. If you've added your signing key to the KEYS file, also update the release copy.

build/release/release.sh finalize

Verify that the resources are present in https://www.apache.org/dist/kyuubi/. It may take a while for them to be visible. This will be mirrored throughout the Apache network.

For Maven Central Repository, you can Release from the Apache Nexus Repository Manager. Log in, open “Staging Repositories”, find the one voted on, select and click “Release” and confirm. If successful, it should show up under https://repository.apache.org/content/repositories/releases/org/apache/kyuubi/ and the same under https://repository.apache.org/content/groups/maven-staging-group/org/apache/kyuubi/ (look for the correct release version). After some time this will be synced to Maven Central automatically.

Promote the release

Update Website

Fork and clone Apache Kyuubi website

  1. Add a new markdown file in src/zh/news/, src/en/news/
  2. Add a new markdown file in src/zh/release/, src/en/release/
  3. Update releases defined in hugo.toml's [params] part.

You can use build/release/pre_gen_release_notes.py to generate the commit log and the contributor list for the release note. Note that the generated lists are only for draft and you still need to edit them.

Create an Announcement

Once everything is working, create an announcement on the website and then send an e-mail to the mailing list. You can generate the announcement via build/release/script/announce.sh automatically. The mailing list includes: announce@apache.org, dev@kyuubi.apache.org, user@spark.apache.org.

Note that, you must use the apache.org email to send announce to announce@apache.org.

Enjoy an adult beverage of your choice, and congratulations on making a Kyuubi release.

Remove the dist repo directories for deprecated release candidates

Remove the deprecated dist repo directories at last.

cd work/svn-dev
svn delete https://dist.apache.org/repos/dist/dev/kyuubi/${RELEASE_TAG} \
  --username "${ASF_USERNAME}" \
  --password "${ASF_PASSWORD}" \
  --message "Remove deprecated Apache Kyuubi ${RELEASE_TAG}"

Archive older releases

Remove older releases from downloads.apache.org. All releases are automatically archived and they are still accessible from archive.apache.org.

According to the ASF release policy, downloads.apache.org should contain the latest release in each branch that is currently under development.

cd work/svn-dev
export OLD_RELEASE=<release path, e.g. kyuubi-1.10.2>
svn delete https://dist.apache.org/repos/dist/release/kyuubi/${OLD_RELEASE} \
  --username "${ASF_USERNAME}" \
  --password "${ASF_PASSWORD}" \
  --message "Archive old ${OLD_RELEASE}"

Keep other artifacts up-to-date