...
- 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.
// Needs to be fixed.
// I found this section in flink release guide. Not sure why our incubating release guide didn't have it.
--------------------------------------------------------------------------------------------------------
Review and update documentation
There are a few pages in the documentation that need to be reviewed and updated for each release.
- Ensure that there exists a release notes page for each non-bugfix release (e.g., 1.5.0) in
./docs/release-notes
/, that it is up-to-date, and linked from the start page of the documentation. - Upgrading Applications and Flink Versions: https://ci.apache.org/projects/flink/flink-docs-master/ops/upgrading.html
- please extend this list.
Unless the pages have not been updated before, please create a JIRA ticket and mark it as release blocker.
--------------------------------------------------------------------------------------------------------
Verify that a Release Build WorksWorks
// 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
...
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 |
// Missing section to verify docs.
Checklist to proceed to the next step
...