This is an automated email from the ASF dual-hosted git repository.
chengpan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kyuubi-shaded.git
The following commit(s) were added to refs/heads/master by this push:
new 092d47b [KYUUBI-SHADED #59] Various improvments for release mail
templates
092d47b is described below
commit 092d47bcf5467b6f56cd6f15f6ca32d3c426866f
Author: Cheng Pan <[email protected]>
AuthorDate: Thu May 22 14:15:04 2025 +0800
[KYUUBI-SHADED #59] Various improvments for release mail templates
### _Why are the changes needed?_
Update vote and announcement mail templates to match the main repo
### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including
negative and positive cases if possible
- [ ] Add screenshots for manual tests if appropriate
- [ ] [Run
test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests)
locally before make a pull request
Closes #59 from pan3793/ann.
57b5788 [Cheng Pan] fix
8db2848 [Cheng Pan] Various improvments for release mail templates
Authored-by: Cheng Pan <[email protected]>
Signed-off-by: Cheng Pan <[email protected]>
---
build/release/script/announce.sh | 15 ++---
build/release/script/dev_kyuubi_vote.sh | 78 +++++++++++++-------------
build/release/tmpl/dev_kyuubi_cancel_vote.tmpl | 6 +-
build/release/tmpl/dev_kyuubi_vote_result.tmpl | 4 +-
4 files changed, 52 insertions(+), 51 deletions(-)
diff --git a/build/release/script/announce.sh b/build/release/script/announce.sh
index 5f1c941..79afe11 100755
--- a/build/release/script/announce.sh
+++ b/build/release/script/announce.sh
@@ -24,31 +24,32 @@ RELEASE_DIR="$(cd "$(dirname "$0")"/..; pwd)"
######### Please modify the variables ##########
# release version, e.g. 0.1.0
-release_version=${release_version:-""}
+RELEASE_VERSION=${RELEASE_VERSION:-""}
################################################
-if [[ -z $release_version ]]; then
+if [[ -z $RELEASE_VERSION ]]; then
echo "Please input release version"
exit 1
fi
-echo "Release version: ${release_version}"
+echo "Release version: ${RELEASE_VERSION}"
RELEASE_TEMP_DIR=${RELEASE_DIR}/tmp
mkdir -p ${RELEASE_TEMP_DIR}
-ANNOUNCE=${RELEASE_TEMP_DIR}/${release_version}_announce.temp
+ANNOUNCE=${RELEASE_TEMP_DIR}/${RELEASE_VERSION}_announce.temp
cat >$ANNOUNCE<<EOF
-Title: [ANNOUNCE] Apache Kyuubi Shaded released ${release_version}
+Title: [ANNOUNCE] Apache Kyuubi Shaded v${RELEASE_VERSION} is available
Content:
Hi all,
The Apache Kyuubi community is pleased to announce that
-Apache Kyuubi Shaded ${release_version} has been released!
+Apache Kyuubi Shaded v${RELEASE_VERSION} has been released!
The full release notes are available at:
-Release Notes: https://kyuubi.apache.org/shaded-release/${release_version}.html
+Release Notes: https://kyuubi.apache.org/shaded-release/${RELEASE_VERSION}.html
+Download Links: https://kyuubi.apache.org/releases.html
To learn more about Apache Kyuubi, please see
https://kyuubi.apache.org/
diff --git a/build/release/script/dev_kyuubi_vote.sh
b/build/release/script/dev_kyuubi_vote.sh
index 6e20b06..acaf507 100755
--- a/build/release/script/dev_kyuubi_vote.sh
+++ b/build/release/script/dev_kyuubi_vote.sh
@@ -23,65 +23,65 @@ set -e
RELEASE_DIR="$(cd "$(dirname "$0")"/..; pwd)"
######### Please modify the variables ##########
-# release version, e.g. v0.1.0
-release_version=${release_version:-""}
-# release candidate number, e.g. rc2
-release_rc_no=${release_rc_no:-""}
-# previous release candidate number, e.g. rc1, could be empty if it is the
first vote
-prev_release_rc_no=${prev_release_rc_no:-""}
-# previous release version, e.g. v0.1.0, this is used to generate change log
-prev_release_version=${prev_release_version:-""}
+# release version, e.g. 0.1.0
+RELEASE_VERSION=${RELEASE_VERSION:-""}
+# release candidate number, e.g. 2
+RELEASE_RC_NO=${RELEASE_RC_NO:-""}
+# previous release candidate number, e.g. 1, could be empty if it is the first
vote
+PREV_RELEASE_RC_NO=${PREV_RELEASE_RC_NO:-""}
+# previous release version, e.g. 0.1.0, this is used to generate change log
+PREV_RELEASE_VERSION=${PREV_RELEASE_VERSION:-""}
# staging repository number, check it under
https://repository.apache.org/content/repositories
-repo_no=${repo_no:-""}
+REPO_NO=${REPO_NO:-""}
################################################
-if [[ -z $release_version ]]; then
+if [[ -z $RELEASE_VERSION ]]; then
echo "Please input release version"
exit 1
fi
-if [[ -z $release_rc_no ]]; then
+if [[ -z $RELEASE_RC_NO ]]; then
echo "Please input release rc number"
exit 1
fi
-if [[ -z $prev_release_version ]]; then
+if [[ -z $PREV_RELEASE_VERSION ]]; then
echo "Please input prev release version which is used to generate change log"
exit 1
fi
-if [[ -z $repo_no ]]; then
+if [[ -z $REPO_NO ]]; then
echo "Please input staging repository number, check it under
https://repository.apache.org/content/repositories "
exit 1
fi
-release_rc_tag=${release_version}-${release_rc_no}
-git_commit_hash=$(git rev-list -n 1 $release_rc_tag)
-
-echo "Release version: ${release_version}"
-echo "Release candidate number: ${release_rc_no}"
-echo "Previous release candidate number: ${prev_release_rc_no}"
-echo "Staging repository number: ${repo_no}"
-echo "Release candidate tag: ${release_rc_tag}"
-echo "Release candidate tag commit hash: ${git_commit_hash}"
-
-if [[ ! -z "$prev_release_rc_no" ]]; then
- prev_release_rc_tag=${release_version}-${prev_release_rc_no}
- change_from_pre_commit="
-The commit list since the ${prev_release_rc_no}:
-https://github.com/apache/kyuubi/compare/${prev_release_rc_tag}...${release_rc_tag}
+RELEASE_RC_TAG=v${RELEASE_VERSION}-rc${RELEASE_RC_NO}
+GIT_COMMIT_HASH=$(git rev-list -n 1 $RELEASE_RC_TAG)
+
+echo "Release version: v${RELEASE_VERSION}"
+echo "Release candidate number: RC${RELEASE_RC_NO}"
+echo "Previous release candidate number: RC${PREV_RELEASE_RC_NO}"
+echo "Staging repository number: ${REPO_NO}"
+echo "Release candidate tag: ${RELEASE_RC_TAG}"
+echo "Release candidate tag commit hash: ${GIT_COMMIT_HASH}"
+
+if [[ ! -z "$PREV_RELEASE_RC_NO" ]]; then
+ PREV_RELEASE_RC_TAG=v${RELEASE_VERSION}-${PREV_RELEASE_RC_NO}
+ CHANGE_FROM_PRE_COMMIT="
+The commit list since the previous RC:
+https://github.com/apache/kyuubi/compare/${PREV_RELEASE_RC_TAG}...${RELEASE_RC_TAG}
"
fi
RELEASE_TEMP_DIR=${RELEASE_DIR}/tmp
mkdir -p ${RELEASE_TEMP_DIR}
-DEV_VOTE=${RELEASE_TEMP_DIR}/${release_rc_tag}_dev_vote.temp
+DEV_VOTE=${RELEASE_TEMP_DIR}/${RELEASE_RC_TAG}_dev_vote.temp
cat >${DEV_VOTE}<<EOF
-Title: [VOTE] Release Apache Kyuubi Shaded ${release_version} ${release_rc_no}
+Title: [VOTE] Release Apache Kyuubi Shaded v${RELEASE_VERSION}
RC${RELEASE_RC_NO}
Content:
Hello Apache Kyuubi PMC and Community,
Please vote on releasing the following candidate as
-Apache Kyuubi Shaded version ${release_version}.
+Apache Kyuubi Shaded v${RELEASE_VERSION}.
Apache Kyuubi Shaded project packages relocated third-party libraries
used by [Apache Kyuubi](https://kyuubi.apache.org/).
@@ -92,27 +92,27 @@ of Kyuubi without regard to the concern of others!
The VOTE will remain open for at least 72 hours.
-[ ] +1 Release this package as Apache Kyuubi Shaded ${release_version}
+[ ] +1 Release this package as Apache Kyuubi Shaded ${RELEASE_VERSION}
[ ] +0
[ ] -1 Do not release this package because ...
To learn more about Apache Kyuubi, please see
https://kyuubi.apache.org/
-The tag to be voted on is ${release_rc_tag} (commit ${git_commit_hash}):
-https://github.com/apache/kyuubi-shaded/tree/${release_rc_tag}
+The tag to be voted on is ${RELEASE_RC_TAG} (commit ${GIT_COMMIT_HASH}):
+https://github.com/apache/kyuubi-shaded/tree/${RELEASE_RC_TAG}
The release files, including signatures, digests, etc. can be found at:
-https://dist.apache.org/repos/dist/dev/kyuubi/kyuubi-shaded-${release_rc_tag}/
+https://dist.apache.org/repos/dist/dev/kyuubi/kyuubi-shaded-${RELEASE_RC_TAG}/
Signatures used for Kyuubi RCs can be found in this file:
https://downloads.apache.org/kyuubi/KEYS
The staging repository for this release can be found at:
-https://repository.apache.org/content/repositories/orgapachekyuubi-${repo_no}/
-${change_from_pre_commit}
-The release note is available in:
-https://github.com/apache/kyuubi-shaded/compare/${prev_release_version}...${release_rc_tag}
+https://repository.apache.org/content/repositories/orgapachekyuubi-${REPO_NO}/
+${CHANGE_FROM_PRE_COMMIT}
+The commit list since the latest released version:
+https://github.com/apache/kyuubi-shaded/compare/v${PREV_RELEASE_VERSION}...${RELEASE_RC_TAG}
Thanks,
On behalf of Apache Kyuubi community
diff --git a/build/release/tmpl/dev_kyuubi_cancel_vote.tmpl
b/build/release/tmpl/dev_kyuubi_cancel_vote.tmpl
index 8eaa525..8cfb893 100644
--- a/build/release/tmpl/dev_kyuubi_cancel_vote.tmpl
+++ b/build/release/tmpl/dev_kyuubi_cancel_vote.tmpl
@@ -15,15 +15,15 @@
# limitations under the License.
#
-Title: [CANCEL][VOTE] Release Apache Kyuubi Shaded {release_version}
{release_rc_no}
+Title: [CANCEL][VOTE] Release Apache Kyuubi Shaded v{RELEASE_VERSION}
RC{RELEASE_RC_NO}
Content:
Hello Apache Kyuubi PMC and Community,
-We need to cancel the Apache Kyuubi Shaded {release_rc_no} due to
{issue_description}[1],
+We need to cancel the Apache Kyuubi Shaded RC{RELEASE_RC_NO} due to
{ISSUE_DESCRIPTION}[1],
and thank everyone who helped vote.
-[1] https://github.com/apache/kyuubi-shaded/issues/{issue_number}
+[1] https://github.com/apache/kyuubi-shaded/issues/{ISSUE_NUMBER}
Thanks,
<Release Manager Name>
diff --git a/build/release/tmpl/dev_kyuubi_vote_result.tmpl
b/build/release/tmpl/dev_kyuubi_vote_result.tmpl
index 52e733f..32fcb1e 100644
--- a/build/release/tmpl/dev_kyuubi_vote_result.tmpl
+++ b/build/release/tmpl/dev_kyuubi_vote_result.tmpl
@@ -15,7 +15,7 @@
# limitations under the License.
#
-Title: [RESULT][VOTE] Release Apache Kyuubi Shaded {release_version}
{release_rc_no}
+Title: [RESULT][VOTE] Release Apache Kyuubi Shaded v{RELEASE_VERSION}
RC{RELEASE_RC_NO}
Content:
Hello Apache Kyuubi PMC and Community,
@@ -34,7 +34,7 @@ The vote closes now as 72hr have passed. The vote PASSES with
-1: None
The vote thread:
-{dev_kyuubi_vote_mail_address}
+{DEV_KYUUBI_VOTE_MAIL_ADDRESS}
Thanks to all who helped with the release! I will be working
on publishing the artifacts soon.
