Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Be appropriately classified as Bug, New Feature, Improvement, etc.
  • Represent noteworthy user-facing changes, such as new functionality, backward-incompatible API changes, or performance improvements.
  • Have occurred since the previous release; an issue that was introduced and fixed between releases should not appear in the Release Notes.
  • Have an issue title that makes sense when read on its own.

Verify that a Release Build Works 

// Verify this after cut_release_branch.sh is executed

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

Create a release branch in apache/hudi repository

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. 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.

...

Code Block
# 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

For Bug Fix release: 

Here is how to go about a bug fix release.

  • Create a branch in your repo (<user>/hudi). 
  • cherry pick commits from master that needs to be part of this release. (git cherry-pick commit-hash)
  • Ensure both compilation and tests are good. 
  • I assume you will have apache/hudi as upstream. If not add it as upstream
  • Once the branch is ready with all commits, go ahead and push your branch to upstream. 
  • Go to apache/hudi repo locally and pull this branch. Here after you can work on this branch and push to origin when need be. 
  • Do not forget to set the env variables from above section. 

Verify that a Release Build Works 

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

Checklist to proceed to the next step

...