This is an automated email from the ASF dual-hosted git repository.
panjuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 1565d253361 Add procedure of releasing Helm Chart (#18453)
1565d253361 is described below
commit 1565d253361f426d3f4f5f28c21f5c5524a03a4e
Author: 吴伟杰 <[email protected]>
AuthorDate: Mon Jun 20 16:48:25 2022 +0800
Add procedure of releasing Helm Chart (#18453)
* Add Helm Chart release procedure
* Add Helm Chart release procedure in English
---
docs/community/content/contribute/release.cn.md | 33 +++++++++++++++++++++++++
docs/community/content/contribute/release.en.md | 33 +++++++++++++++++++++++++
2 files changed, 66 insertions(+)
diff --git a/docs/community/content/contribute/release.cn.md
b/docs/community/content/contribute/release.cn.md
index e604142aa74..e0eeb77b152 100644
--- a/docs/community/content/contribute/release.cn.md
+++ b/docs/community/content/contribute/release.cn.md
@@ -200,6 +200,11 @@ grep -l -r "${PREVIOUS.RELEASE.VERSION}" . | xargs sed -i
-e "s/${PREVIOUS.RELEA
将 `README.md` 和 `README_ZH.md` 里的 `${PREVIOUS.RELEASE.VERSION}` 修改为
`${RELEASE.VERSION}`。
+### 6. 更新 Helm Chart 版本
+
+Helm Chart 可以部署不同版本的 ShardingSphere-Proxy，版本号独立于 ShardingSphere 版本。
+修改文件 `shardingsphere-charts/apache-shardingsphere-proxy/Chart.yaml` 中的
`version`。
+
## 发布 Apache Maven 中央仓库
### 1. 设置 settings.xml 文件
@@ -270,6 +275,20 @@ mvn release:perform -Prelease -Darguments="-DskipTests
-Dspotless.apply.skip=tru
点击 `Close` 来告诉 Nexus 这个构建已经完成，只有这样该版本才是可用的。
如果电子签名等出现问题，`Close` 会失败，可以通过 `Activity` 查看失败信息。
+## 构建 Helm Chart
+
+```shell
+cd shardingsphere-charts/apache-shardingsphere-proxy/charts/governance
+helm dep build
+cd ../..
+helm dep build
+cd ..
+helm package apache-shardingsphere-proxy
+mv apache-shardingsphere-proxy-${CHART.RELEASE.VERSION}.tgz
apache-shardingsphere-proxy-chart-${CHART.RELEASE.VERSION}.tgz
+gpg --armor --detach-sign
apache-shardingsphere-proxy-chart-${CHART.RELEASE.VERSION}.tgz
+shasum -b -a 512
apache-shardingsphere-proxy-chart-${CHART.RELEASE.VERSION}.tgz >
apache-shardingsphere-proxy-chart-${CHART.RELEASE.VERSION}.tgz.sha512
+```
+
## 发布 Apache SVN 仓库
### 1. 检出 ShardingSphere 发布目录
@@ -312,6 +331,7 @@ cp -f
~/shardingsphere/shardingsphere-distribution/shardingsphere-src-distributi
cp -f
~/shardingsphere/shardingsphere-distribution/shardingsphere-jdbc-distribution/target/*.tar.gz*
~/ss_svn/dev/shardingsphere/${RELEASE.VERSION}
cp -f
~/shardingsphere/shardingsphere-distribution/shardingsphere-proxy-distribution/target/*.tar.gz*
~/ss_svn/dev/shardingsphere/${RELEASE.VERSION}
cp -f
~/shardingsphere/shardingsphere-agent/shardingsphere-agent-distribution/target/*.tar.gz*
~/ss_svn/dev/shardingsphere/${RELEASE.VERSION}
+cp -f ~/shardingsphere/shardingsphere-charts/*.tgz*
~/ss_svn/dev/shardingsphere/${RELEASE.VERSION}
```
### 4. 提交 Apache SVN
@@ -409,6 +429,19 @@ diff -r
apache-shardingsphere-${RELEASE.VERSION}-src-release shardingsphere-${RE
- 依赖许可证的完整版全部在 `license` 目录；
- 如果依赖的是 Apache 许可证并且存在 `NOTICE` 文件，那么这些 `NOTICE` 文件也需要加入到版本的 `NOTICE` 文件中。
+**3.4 检查 Helm Chart 制品包内容**
+
+解压缩 `apache-shardingsphere-proxy-chart-${CHART.RELEASE.VERSION}.tgz`
+
+进行如下检查：
+- 存在 `LICENSE` 和 `NOTICE` 文件；
+- `NOTICE` 文件中的年份正确；
+- 文本文件开头都有 ASF 许可证，以下文件或目录除外：
+ - 所有 Chart.yaml
+ - 所有 Chart.lock
+ - charts/governance/charts 目录
+ - charts/common 目录
+
## 发起投票
**投票阶段**
diff --git a/docs/community/content/contribute/release.en.md
b/docs/community/content/contribute/release.en.md
index cb308c10083..8a143aae52a 100644
--- a/docs/community/content/contribute/release.en.md
+++ b/docs/community/content/contribute/release.en.md
@@ -202,6 +202,11 @@ Specifying version of xsd instead of using `sharding.xsd`,
is to make legacy doc
Update `${PREVIOUS.RELEASE.VERSION}` to `${RELEASE.VERSION}` in README.md and
README_ZH.md
+### 6. Update version of Helm Chart
+
+Helm Chart can deploy different versions of ShardingSphere-Proxy. Its version
is independent of the version of ShardingSphere.
+Modify the `version` in
`shardingsphere-charts/apache-shardingsphere-proxy/Chart.yaml`.
+
## Apache Maven Central Repository Release
### 1. Set settings.xml
@@ -273,6 +278,20 @@ Visit
[https://repository.apache.org/#stagingRepositories](https://repository.ap
Click `Close` to tell Nexus that the construction is finished, because only in
this way, this version can be usable.
If there is any problem in gpg signature, `Close` will fail, but you can see
the failure information through `Activity`.
+## Build Helm Chart archive
+
+```shell
+cd shardingsphere-charts/apache-shardingsphere-proxy/charts/governance
+helm dep build
+cd ../..
+helm dep build
+cd ..
+helm package apache-shardingsphere-proxy
+mv apache-shardingsphere-proxy-${CHART.RELEASE.VERSION}.tgz
apache-shardingsphere-proxy-chart-${CHART.RELEASE.VERSION}.tgz
+gpg --armor --detach-sign
apache-shardingsphere-proxy-chart-${CHART.RELEASE.VERSION}.tgz
+shasum -b -a 512
apache-shardingsphere-proxy-chart-${CHART.RELEASE.VERSION}.tgz >
apache-shardingsphere-proxy-chart-${CHART.RELEASE.VERSION}.tgz.sha512
+```
+
## Apache SVN Repository Release
### 1. Checkout ShardingSphere Release Directory
@@ -316,6 +335,7 @@ cp -f
~/shardingsphere/shardingsphere-distribution/shardingsphere-src-distributi
cp -f
~/shardingsphere/shardingsphere-distribution/shardingsphere-jdbc-distribution/target/*.tar.gz*
~/ss_svn/dev/shardingsphere/${RELEASE.VERSION}
cp -f
~/shardingsphere/shardingsphere-distribution/shardingsphere-proxy-distribution/target/*.tar.gz*
~/ss_svn/dev/shardingsphere/${RELEASE.VERSION}
cp -f
~/shardingsphere/shardingsphere-agent/shardingsphere-agent-distribution/target/*.tar.gz*
~/ss_svn/dev/shardingsphere/${RELEASE.VERSION}
+cp -f ~/shardingsphere/shardingsphere-charts/*.tgz*
~/ss_svn/dev/shardingsphere/${RELEASE.VERSION}
```
### 4. Commit to Apache SVN
@@ -413,6 +433,19 @@ And check the following items:
* All the third party dependency licenses are under `licenses` folder
* If it depends on Apache license and has a `NOTICE` file, that `NOTICE`
file need to be added to `NOTICE` file of the release
+**3.4 Check Helm Chart archive**
+
+Decompress `apache-shardingsphere-proxy-chart-${CHART.RELEASE.VERSION}.tgz`
+
+And check the following items:
+* `LICENSE` and `NOTICE` files exist
+* Correct year in `NOTICE` file
+* All text files have ASF headers, excepts the following files or
directories:
+ * All Chart.yaml
+ * All Chart.lock
+ * Directory charts/governance/charts
+ * Directory charts/common
+
## Call for a Vote
**Vote procedure**
