This release process document is based on Apache Beam Release Guide and Apache Flink Release Guide
The Apache Hudi 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”, “stable”, etc.
Hudi 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 Hudi community in a public vote.
Each release is executed by a Release Manager, who is selected among the Hudi PMC members. 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.
The release process consists of several steps:
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 3-5 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.
As a release manager, you should create a private Slack channel, named `hudi-<version>_release_work` (e.g. hudi-0_12_0_release_work) in Apache Hudi Slack for coordination. Invite all committers to the channel.
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.
To prepare for each release, you should audit the project status in the JIRA issue tracker, and do the necessary bookkeeping. Finally, you should create a release branch from which individual release candidates will be built.
NOTE: If you are using GitHub two-factor authentication and haven’t configure HTTPS access, please follow the guide to configure command line access.
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 follow the section below.
There are 2 ways to configure your GPG key for release, either using release automation script(which is recommended), or running all commands manually. If using Mac, please see below to handle known issues.
Usage ./hudi/scripts/release/preparation_before_release.shsudo apt-get install rng-tools
sudo rngd -r /dev/urandom
gpg --full-generate-key
Here, the key ID is the 8-digit hex string in the pub line: 845E6689 or more than 8-digit hex string like 623E08E06DB376684FB9599A3F5953147903948A.
Now, add your Apache GPG key to the Hudi’s KEYS file both in dev and release repositories at dist.apache.org. Follow the instructions listed at the top of these files. (Note: Only PMC members have write access to the release repository. If you end up getting 403 errors ask on the mailing list for assistance.)
git config --global user.signingkey CD4C59FD, or git config --global user.signingkey 623E08E06DB376684FB9599A3F5953147903948A
eval $(gpg-agent --daemon --no-grab --write-env-file $HOME/.gpg-agent-info)
export GPG_TTY=$(tty)
export GPG_AGENT_INFO
To checkout you need subversion. If subversion is not available in Mac you might have to first install it using `brew install subversion`.
Configure access to the Apache Nexus repository, which enables final deployment of releases to the Maven Central Repository.
<settings> <servers> <server> <id>apache.releases.https</id> <username>TOKEN_NAME</username> <password>TOKEN_PASSWORD</password> </server> <server> <id>apache.snapshots.https</id> <username>TOKEN_NAME</username> <password>TOKEN_PASSWORD</password> </server> </servers> </settings> |
In order to make yourself have the right permission to stage java artifacts in Apache Nexus staging repository, please submit your GPG public key into MIT PGP Public Key Server.
Also send 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 |
would also refer to stackoverflow.
When contributors resolve an issue in JIRA, they are tagging it with a release that will contain their changes. With the release currently underway, new issues should be resolved against a subsequent future release. Therefore, you should create a release item for this subsequent release, as follows:
Attention: Only PMC has permission to perform this. If you are not a PMC, please ask for help in dev@ mailing list.
There could be outstanding release-blocking issues, which should be triaged before proceeding to build a release candidate. We track them by assigning a specific Fix version field even before the issue resolved.
The list of release-blocking issues is available at the version status page. Triage each unresolved issue with one of the following resolutions:
For all JIRA issues:
For JIRA issues with type “Bug” or labeled “flaky”:
For all other JIRA issues:
If there is a bug found in the RC creation process/tools, those issues should be considered high priority and fixed in 7 days.
JIRA automatically generates Release Notes based on the Fix Version field applied to issues. Release Notes are intended for Hudi users (not Hudi committers/contributors). You should ensure that Release Notes are informative and useful.
Open the release notes from the version status page by choosing the release underway and clicking Release Notes.
You should verify that the issues listed automatically by JIRA are appropriate to appear in the Release Notes. Specifically, issues should:
Attention: Only committer has permission to create release branch in apache/hudi. Skip this step if it is a bug fix release. But do set the env variables.
Release candidates are built from a release branch. As a final step in preparation for the release, you should create the release branch, push it to the Apache code repository, and update version information on the original branch.
Export Some Environment variables in the terminal where you are running the release scripts
export RELEASE_VERSION=<RELEASE_VERSION_TO_BE_PUBLISHED>
export NEXT_VERSION=<NEW_VERSION_IN_MASTER>
export RELEASE_BRANCH=release-<RELEASE_VERSION_TO_BE_PUBLISHED>
export RC_NUM=<release_candidate_num_starting_from_1>
Use cut_release_branch.sh to cut a release branch
Usage
# Cut a release branch
Cd scripts && ./release/cut_release_branch.sh \
--release=${RELEASE_VERSION} \
--next_release=${NEXT_VERSION} \
--rc_num=${RC_NUM}
# Show help page
./hudi/scripts/release/cut_release_branch.sh -h |
Here is how to go about a bug fix release.
mvn versions:set -DnewVersion=${RELEASE}-rc${RC_NUM}", with "RELEASE" as the version and "RC_NUM" as the RC number. Make sure the version changes are intended. Then git commit the changes.Run "mvn -Prelease clean install" to ensure that the build processes are in good shape. // You need to execute this command once you have the release branch in apache/hudi
Good to run this for all profiles
mvn -Prelease clean install mvn -Prelease clean install -Dscala-2.12 mvn -Prelease clean install -Dspark3 |
The core of the release process is the build-vote-fix cycle. Each cycle produces one release candidate. The Release Manager repeats this cycle until the community approves one release candidate, which is then finalized.
Set up a few environment variables to simplify Maven commands that follow. This identifies the release candidate being built. Start with RC_NUM equal to 1 and increment it for each candidate.
git checkout ${RELEASE_BRANCH}mvn versions:set -DnewVersion=${RELEASE_VERSION}-rc${RC_NUM}mvn test -DskipITs=truemvn verify -DskipUTs=truegit commit -am "Bumping release candidate number ${RC_NUM}" There will be some backup files created which needs to be removed. You could do "git clean -fd" before doing the commit.
git push origin ${RELEASE_BRANCH}
If you already have a remote tag with same name as your branch, you can try below command.
git push origin refs/heads/${RELEASE_BRANCH}
"refs/heads/" refers to a branch.
"refs/tags/" refers to tag.
git checkout ${RELEASE_BRANCH}cd scripts && ./release/create_source_release.sh
If you have multiple gpg keys(gpg --list-keys), then the signing command will take in the first key most likely. You will release this when it asks for a passphrase in a pop up. When asked for passphrase, ensure the intended key is the one asked for.
Command used in script:
gpg --armor --detach-sig ${RELEASE_DIR}/hudi-${RELEASE_VERSION}.src.tgz
To use a specific key: update as follows: // replace FINGERPRINT
gpg --local-user [FINGERPRINT] --armor --detach-sig ${RELEASE_DIR}/hudi-${RELEASE_VERSION}.src.tgz
git tag -s release-${RELEASE_VERSION}-rc${RC_NUM} -m "${RELEASE_VERSION}"
If you run into some issues, and if want to re-run the same candidate again from start, ensure you delete existing tags before retrying again.
// to remove local
git tag -d release-${RELEASE_VERSION}-rc${RC_NUM}
// to remove remote
git push --delete origin release-${RELEASE_VERSION}-rc${RC_NUM}
git push origin release-${RELEASE_VERSION}-rc${RC_NUM} If a branch with the same name already exists in origin, this command might fail as below.
error: src refspec release-0.5.3 matches more than one
error: failed to push some refs to 'https://github.com/apache/hudi.git'
In such a case, try below command
git push origin refs/tags/release-${RELEASE_VERSION}-rc${RC_NUM}
svn checkout https://dist.apache.org/repos/dist/dev/hudi --depth=immediates
mkdir hudi/hudi-${RELEASE_VERSION}-rc${RC_NUM}mv <hudi-dir>/src_release/* hudi/hudi-${RELEASE_VERSION}-rc${RC_NUM}cd hudi
svn add hudi-${RELEASE_VERSION}-rc${RC_NUM}svn commit
For RC: cd scripts && ./release/validate_staged_release.sh --release=${RELEASE_VERSION} --rc_num=${RC_NUM} --verbose
git checkout ${RELEASE_BRANCH}
If the prompt is not for the same key (by default the maven-gpg-plugin will pick up the first key in your keyring so that could be different), then add the following option to your ~/.gnupg/gpg.conf file
default-key <FINGERPRINT_OF_KEY_USED_FOR_SOURCE_RELEASE> |
./scripts/release/validate_staged_bundles.sh orgapachehudi-<stage_repo_number> ${RELEASE_VERSION}-rc${RC_NUM} 2>&1 | tee -a /tmp/validate_staged_bundles_output.txtMaven artifacts deployed to the staging repository of repository.apache.org
Source distribution deployed to the dev repository of dist.apache.org and validated
Once you have built and individually reviewed the release candidate, please share it for the community-wide(dev@hudi ) review. Please review foundation-wide voting guidelines for more information.
Start the review-and-vote thread on the dev@ mailing list. Here’s an email template; please adjust as you see fit.
From: Release Manager Subject: [VOTE] Release 1.2.3, release candidate #3
Hi everyone, Please review and vote on the release candidate #3 for the version 1.2.3, as follows: [ ] +1, Approve the release [ ] -1, Do not approve the release (please provide specific comments)
The complete staging area is available for your review, which includes: * JIRA release notes [1], * the official Apache source release and binary convenience releases to be deployed to dist.apache.org [2], which are signed with the key with fingerprint FFFFFFFF [3], * all artifacts to be deployed to the Maven Central Repository [4], * source code tag "1.2.3-rc3" [5],
The vote will be open for at least 72 hours. It is adopted by majority approval, with at least 3 PMC affirmative votes.
Thanks, Release Manager
[1] link [2] link [3] https://dist.apache.org/repos/dist/release/hudi/KEYS [4] link [5] link [6] link |
If there are any issues found in the release candidate, reply on the vote thread to cancel the vote, and there’s no need to wait 72 hours if any issues found. Proceed to the Fix Issues step below and address the problem. However, some issues don’t require cancellation. For example, if an issue is found in the website, just correct it on the spot and the vote can continue as-is.
If there are no issues, reply on the vote thread to close the voting. Then, tally the votes in a separate email. Here’s an email template; please adjust as you see fit.
From: Release Manager Subject: [RESULT] [VOTE] Release 1.2.3, release candidate #3
I'm happy to announce that we have unanimously approved this release.
There are XXX approving votes, XXX of which are binding: * approver 1 * approver 2 * approver 3 * approver 4
There are no disapproving votes.
Thanks everyone! |
Please look at previous examples in previous releases. For example : Please see examples here : voting in dev , voting in general and result of voting
Any issues identified during the community review and vote should be fixed in this step.
Code changes should be proposed as standard pull requests to the master branch and reviewed using the normal contributing process. Then, relevant changes should be cherry-picked into the release branch. The cherry-pick commits should then be proposed as the pull requests against the release branch, again reviewed and merged using the normal contributing process.
Once all issues have been resolved, you should go back and build a new release candidate with these changes.
Once the release candidate has been reviewed and approved by the community, the release should be finalized. This involves the final deployment of the release candidate to the release repositories, merging of the website changes, etc.
Staging Repositories section, find the relevant release candidate orgapachehudi-XXX entry and click Release. Drop all other release candidates that are not being released. It can take up to 24 hours for the new release to show up in Maven Central repository. Once the release has been finalized, the last step of the process is to promote the release within the project and beyond. Please wait for 1h after finalizing the release in accordance with the ASF release policy.
Announce on the dev@ mailing list that the release has been finished.
Announce on the release on the user@ mailing list, listing major improvements and contributions.
Announce the release on the announce@apache.org mailing list. NOTE: put announce@apache.org in bcc to avoid disrupting people with followups.
Considering that announce@ ML has restrictions on what is published, we can follow this email template:
From: Release Manager Subject: [ANNOUNCE] Apache Hudi <VERSION> released
The Apache Hudi team is pleased to announce the release of Apache Hudi <VERSION>. Apache Hudi (pronounced Hoodie) stands for Hadoop Upserts Deletes and Incrementals. Apache Hudi manages storage of large analytical datasets on DFS (Cloud stores, HDFS or any Hadoop FileSystem compatible storage) and provides the ability to query them. This release comes xxx months after xxx. It includes more than For details on how to use Hudi, please look at the quick start page located at https://hudi.apache.org/docs/quick-start-guide.html If you'd like to download the source release, you can find it here: https://github.com/apache/hudi/releases/tag/<VERSION> You can read more about the release (including release notes) here: https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12322822&version=<JIRA_VERSION> We welcome your help and feedback. For more information on how to Thanks to everyone involved! XXX |
Use reporter.apache.org to seed the information about the release into future project reports.
Tweet, post on Facebook, LinkedIn, and other platforms. Ask other contributors to do the same.
It is important that we improve the release processes over time. Once you’ve finished the release, please take a step back and look what areas of this process and be improved. Perhaps some part of the process can be simplified. Perhaps parts of this guide can be clarified.
If we have specific ideas, please start a discussion on the dev@ mailing list and/or propose a pull request to update this guide. Thanks!