You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kyuubi.apache.org by ul...@apache.org on 2021/12/06 12:32:12 UTC

[incubator-kyuubi] branch master updated: [KYUUBI #1487] Correct the KEYS link and add script to generate vote and announcement

This is an automated email from the ASF dual-hosted git repository.

ulyssesyou pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-kyuubi.git


The following commit(s) were added to refs/heads/master by this push:
     new 940c6c1  [KYUUBI #1487] Correct the KEYS link and add script to generate vote and announcement
940c6c1 is described below

commit 940c6c1b5c76f3f06ac58b14792f44d39e83777c
Author: Fei Wang <fw...@ebay.com>
AuthorDate: Mon Dec 6 20:31:59 2021 +0800

    [KYUUBI #1487] Correct the KEYS link and add script to generate vote and announcement
    
    <!--
    Thanks for sending a pull request!
    
    Here are some tips for you:
      1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
      2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
      3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
    -->
    
    ### _Why are the changes needed?_
    <!--
    Please clarify why the changes are needed. For instance,
      1. If you add a feature, you can talk about the use case of it.
      2. If you fix a bug, you can clarify why it is a bug.
    -->
    
    Correct the KEYS link in release template.
    
    ### _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
    
    - [x] [Run test](https://kyuubi.readthedocs.io/en/latest/develop_tools/testing.html#running-tests) locally before make a pull request
    
    Closes #1487 from turboFei/release_template.
    
    Closes #1487
    
    93e5fc62 [Fei Wang] fix
    e06104ba [Fei Wang] refactor
    feaab6e2 [Fei Wang] address comments
    7675f0c7 [Fei Wang] add shell scripts
    83601752 [Fei Wang] Correct the KEYS link in release template
    
    Authored-by: Fei Wang <fw...@ebay.com>
    Signed-off-by: ulysses-you <ul...@apache.org>
---
 .gitignore                                         |   1 +
 .../{tmpl/announce.tmpl => script/announce.sh}     |  40 +++++--
 build/release/script/dev_kyuubi_vote.sh            | 110 +++++++++++++++++
 build/release/script/general_incubator_vote.sh     | 131 +++++++++++++++++++++
 build/release/tmpl/dev_kyuubi_vote.tmpl            |  58 ---------
 build/release/tmpl/general_incubator_vote.tmpl     |  60 ----------
 6 files changed, 274 insertions(+), 126 deletions(-)

diff --git a/.gitignore b/.gitignore
index 3dc12fc..608364d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -43,6 +43,7 @@
 .scala_dependencies
 .settings
 build/apache-maven*
+build/release/tmp
 build/scala*
 build/test
 target/
diff --git a/build/release/tmpl/announce.tmpl b/build/release/script/announce.sh
similarity index 70%
rename from build/release/tmpl/announce.tmpl
rename to build/release/script/announce.sh
index 2196fcd..94c0c44 100644
--- a/build/release/tmpl/announce.tmpl
+++ b/build/release/script/announce.sh
@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
 # contributor license agreements.  See the NOTICE file distributed with
@@ -15,17 +17,35 @@
 # limitations under the License.
 #
 
-Title: [ANNOUNCE] Apache Kyuubi (Incubating) released {release_version}
+set -o pipefail
+set -e
 
-Content:
-Hi all,
+RELEASE_DIR="$(cd "$(dirname "$0")"/..; pwd)"
+
+######### Please modify the variables ##########
+# release version, e.g. 1.4.0-incubating
+release_version=${release_version:-""}
+################################################
+
+if [[ -z $release_version ]]; then
+  echo "Please input release version"
+  exit 1
+fi
+
+echo "Release version: ${release_version}"
 
-# (To user@spark.apache.org)
-# Hello Spark Community,
-##
+RELEASE_TEMP_DIR=${RELEASE_DIR}/tmp
+mkdir -p ${RELEASE_TEMP_DIR}
+ANNOUNCE=${RELEASE_TEMP_DIR}/${release_version}_announce.temp
+
+cat >$ANNOUNCE<<EOF
+Title: [ANNOUNCE] Apache Kyuubi (Incubating) released ${release_version}
+
+Content:
+Hello Kyuubi Community,
 
 The Apache Kyuubi (Incubating) community is pleased to announce that
-Apache Kyuubi (Incubating) {release_version} has been released!
+Apache Kyuubi (Incubating) ${release_version} has been released!
 
 Apache Kyuubi (Incubating) is a distributed multi-tenant JDBC server for
 large-scale data processing and analytics, built on top of Apache Spark
@@ -46,7 +66,7 @@ provides the administrators a way to achieve computing resource isolation,
 data security, high availability, high client concurrency, etc.
 
 The full release notes and download links are available at:
-Release Notes: https://kyuubi.apache.org/release/{release_version}.html
+Release Notes: https://kyuubi.apache.org/release/${release_version}.html
 
 To learn more about Apache Kyuubi (Incubating), please see
 https://kyuubi.apache.org/
@@ -60,3 +80,7 @@ community who made this release possible!
 
 Thanks,
 On behalf of Apache Kyuubi (Incubating) community
+EOF
+
+echo "please Use dev@kyuubi.apache.com
+see announce content in $ANNOUNCE"
diff --git a/build/release/script/dev_kyuubi_vote.sh b/build/release/script/dev_kyuubi_vote.sh
new file mode 100644
index 0000000..33c7228
--- /dev/null
+++ b/build/release/script/dev_kyuubi_vote.sh
@@ -0,0 +1,110 @@
+#!/usr/bin/env bash
+
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+set -o pipefail
+set -e
+
+RELEASE_DIR="$(cd "$(dirname "$0")"/..; pwd)"
+
+######### Please modify the variables ##########
+# release version, e.g. 1.4.0-incubating
+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:-""}
+# staging repository number, check it under https://repository.apache.org/content/repositories
+repo_no=${repo_no:-""}
+################################################
+
+if [[ -z $release_version ]]; then
+  echo "Please input release version"
+  exit 1
+fi
+if [[ -z $release_rc_no ]]; then
+  echo "Please input release rc number"
+  exit 1
+fi
+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/incubator-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
+
+cat >${DEV_VOTE}<<EOF
+Title: [VOTE] Release Apache Kyuubi ${release_version} ${release_rc_no}
+
+Content:
+Hello Apache Kyuubi PPMC and Community,
+
+Please vote on releasing the following candidate as
+Apache Kyuubi (Incubating) version ${release_version}.
+
+The VOTE will remain open for at least 72 hours.
+
+[ ] +1 Release this package as Apache Kyuubi ${release_version}
+[ ] +0
+[ ] -1 Do not release this package because ...
+
+To learn more about Apache Kyuubi (Incubating), please see
+https://kyuubi.apache.org/
+
+The tag to be voted on is ${release_rc_tag} (commit ${git_commit_hash}):
+https://github.com/apache/incubator-kyuubi/tree/${release_rc_tag}
+
+The release files, including signatures, digests, etc. can be found at:
+https://dist.apache.org/repos/dist/dev/incubator/kyuubi/${release_rc_tag}/
+
+Signatures used for Kyuubi RCs can be found in this file:
+https://downloads.apache.org/incubator/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/incubator-kyuubi/releases/tag/${release_rc_tag}
+
+Thanks,
+On behalf of Apache Kyuubi(Incubating) community
+EOF
+
+echo "please use dev@kyuubi.apache.com
+see vote content in $DEV_VOTE
+please check all the links and ensure they are available"
diff --git a/build/release/script/general_incubator_vote.sh b/build/release/script/general_incubator_vote.sh
new file mode 100644
index 0000000..3e52dd6
--- /dev/null
+++ b/build/release/script/general_incubator_vote.sh
@@ -0,0 +1,131 @@
+#!/usr/bin/env bash
+
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+set -o pipefail
+set -e
+
+RELEASE_DIR="$(cd "$(dirname "$0")"/..; pwd)"
+######### Please modify the variables ##########
+# release version, e.g. 1.4.0-incubating
+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:-""}
+# staging repository number, check it under https://repository.apache.org/content/repositories
+repo_no=${repo_no:-""}
+# vote email address in dev@kyuubi.apache.org, e.g. https://www.mail-archive.com/dev@kyuubi.apache.org/msg01458.html
+dev_kyuubi_vote_mail_address=${dev_kyuubi_vote_mail_address:-""}
+# vote result email address in dev@kyuubi.apache.org, e.g. https://www.mail-archive.com/dev@kyuubi.apache.org/msg01492.html
+dev_kyuubi_vote_result_mail_address=${dev_kyuubi_vote_result_mail_address:-""}
+################################################
+
+if [[ -z $release_version ]]; then
+  echo "Please input release version"
+  exit 1
+fi
+if [[ -z $release_rc_no ]]; then
+  echo "Please input release rc number"
+  exit 1
+fi
+if [[ -z $repo_no ]]; then
+  echo "Please input staging repository number, check it under https://repository.apache.org/content/repositories"
+  exit 1
+fi
+if [[ -z $dev_kyuubi_vote_mail_address ]]; then
+  echo "Please input vote email address in dev@kyuubi.apache.org"
+  exit 1
+fi
+if [[ -z $dev_kyuubi_vote_result_mail_address ]]; then
+  echo "vote result email address in dev@kyuubi.apache.org"
+  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 "Vote email address in dev@kyuubi.apache.org: ${dev_kyuubi_vote_mail_address}"
+echo "Vote result email address in dev@kyuubi.apache.org: ${dev_kyuubi_vote_result_mail_address}"
+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/incubator-kyuubi/compare/${prev_release_rc_tag}...${release_rc_tag}
+"
+fi
+
+RELEASE_TEMP_DIR=${RELEASE_DIR}/tmp
+mkdir -p ${RELEASE_TEMP_DIR}
+GENERAL_VOTE=${RELEASE_TEMP_DIR}/${release_rc_tag}_general_vote.temp
+
+cat >$GENERAL_VOTE<<EOF
+Title: [VOTE] Release Apache Kyuubi(Incubating) ${release_version} ${release_rc_no}
+
+Content:
+Hello Incubator Community,
+
+The Apache Kyuubi community has voted on and approved a proposal to release
+Apache Kyuubi(Incubating) version ${release_version} ${release_rc_no}.
+
+We now kindly request the Incubator PMC members review and vote on this
+incubator release.
+
+Kyuubi community vote thread:
+${dev_kyuubi_vote_mail_address}
+
+Vote result thread:
+${dev_kyuubi_vote_result_mail_address}
+
+[ ] +1 Release this package as Apache Kyuubi ${release_version}
+[ ] +0
+[ ] -1 Do not release this package because ...
+
+To learn more about Apache Kyuubi (Incubating), please see
+https://kyuubi.apache.org/
+
+The tag to be voted on is ${release_rc_tag} (commit ${git_commit_hash}):
+https://github.com/apache/incubator-kyuubi/tree/${release_rc_tag}
+
+The release files, including signatures, digests, etc. can be found at:
+https://dist.apache.org/repos/dist/dev/incubator/kyuubi/${release_rc_tag}/
+
+Signatures used for Kyuubi RCs can be found in this file:
+https://downloads.apache.org/incubator/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/incubator-kyuubi/releases/tag/${release_rc_tag}
+
+
+Thanks,
+On behalf of Apache Kyuubi(Incubating) community
+EOF
+
+echo "please use general@incubator.apache.com
+see vote content in $GENERAL_VOTE
+please check all the links and ensure they are available"
diff --git a/build/release/tmpl/dev_kyuubi_vote.tmpl b/build/release/tmpl/dev_kyuubi_vote.tmpl
deleted file mode 100644
index 9b48ae6..0000000
--- a/build/release/tmpl/dev_kyuubi_vote.tmpl
+++ /dev/null
@@ -1,58 +0,0 @@
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements.  See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License.  You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-Title: [VOTE] Release Apache Kyuubi {release_version} {release_rc_no}
-
-Content:
-Hello Apache Kyuubi PPMC and Community,
-
-Please vote on releasing the following candidate as
-Apache Kyuubi (Incubating) version {release_version}.
-
-The VOTE will remain open for at least 72 hours.
-
-[ ] +1 Release this package as Apache Kyuubi {release_version}
-[ ] +0
-[ ] -1 Do not release this package because ...
-
-To learn more about Apache Kyuubi (Incubating), please see
-https://kyuubi.apache.org/
-
-The tag to be voted on is {release_rc_tag} (commit {git_commit_hash}):
-https://github.com/apache/incubator-kyuubi/tree/{release_rc_tag}
-
-The release files, including signatures, digests, etc. can be found at:
-https://dist.apache.org/repos/dist/dev/incubator/kyuubi/{release_rc_tag}/
-
-Signatures used for Kyuubi RCs can be found in this file:
-https://dist.apache.org/repos/dist/dev/incubator/kyuubi/KEYS
-
-The staging repository for this release can be found at:
-https://repository.apache.org/content/repositories/orgapachekyuubi-{repo_no}/
-
-# (Optional)
-# The commit list since the {prev_release_rc_no}:
-# https://github.com/apache/incubator-kyuubi/compare/{prev_release_rc_tag}...{release_rc_tag}
-##
-
-# (Optional)
-# Release Notes:
-# https://github.com/apache/incubator-kyuubi/discussions/{release_discussion_no}
-##
-
-Thanks,
-On behalf of Apache Kyuubi(Incubating) community
diff --git a/build/release/tmpl/general_incubator_vote.tmpl b/build/release/tmpl/general_incubator_vote.tmpl
deleted file mode 100644
index 0b38726..0000000
--- a/build/release/tmpl/general_incubator_vote.tmpl
+++ /dev/null
@@ -1,60 +0,0 @@
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements.  See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License.  You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-Title: [VOTE] Release Apache Kyuubi(Incubating) {release_version} {release_rc_no}
-
-Content:
-Hello Incubator Community,
-
-The Apache Kyuubi community has voted on and approved a proposal to release
-Apache Kyuubi(Incubating) version {release_version} {release_rc_no}.
-
-We now kindly request the Incubator PMC members review and vote on this
-incubator release.
-
-Kyuubi community vote thread:
-{dev_kyuubi_vote_mail_address}
-
-Vote result thread:
-{dev_kyuubi_vote_result_mail_address}
-
-[ ] +1 Release this package as Apache Kyuubi {release_version}
-[ ] +0
-[ ] -1 Do not release this package because ...
-
-To learn more about Apache Kyuubi (Incubating), please see
-https://kyuubi.apache.org/
-
-The tag to be voted on is {release_rc_tag} (commit {git_commit_hash}):
-https://github.com/apache/incubator-kyuubi/tree/{release_rc_tag}
-
-The release files, including signatures, digests, etc. can be found at:
-https://dist.apache.org/repos/dist/dev/incubator/kyuubi/{release_rc_tag}/
-
-Signatures used for Kyuubi RCs can be found in this file:
-https://dist.apache.org/repos/dist/dev/incubator/kyuubi/KEYS
-
-The staging repository for this release can be found at:
-https://repository.apache.org/content/repositories/orgapachekyuubi-{repo_no}/
-
-# (Optional)
-# The commit list since the {prev_release_rc_no}:
-# https://github.com/apache/incubator-kyuubi/compare/{prev_release_rc_tag}...{release_rc_tag}
-##
-
-Thanks,
-On behalf of Apache Kyuubi(Incubating) community