Skip to content

Commit 8bb8208

Browse files
zhzhuang-zjushivansh-bhatnagar18
authored andcommitted
update release.md
Signed-off-by: zhzhuang-zju <m17799853869@163.com>
1 parent dc93e6d commit 8bb8208

File tree

4 files changed

+24
-3
lines changed

4 files changed

+24
-3
lines changed

docs/developers/releasing.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,17 @@ The highlighted updates, for example, new key features. This part is collected m
4040
### Instrumentation
4141
* Observability-related changes. For example, metric adding/event recording.
4242
```
43-
Compare the newly created minor release branch with the previous minor release tag, for example, compare `release-1.4` branch with `v1.3.0` tag, to get all relevant changes. Then extract the preceding types of release notes from these changes. For example, extract [this](https://github.com/karmada-io/karmada/pull/2675) as:
43+
#### Collect changes(manually)
44+
Compare the newly created minor release branch with its pre-release tag, for example, compare `release-1.8` branch with `v1.8.0-alpha.0` tag, to get all relevant changes. Here's how it works on GitHub:
45+
46+
- Enter the [Compare page](https://github.com/karmada-io/karmada/compare).
47+
- Choose the pre-release tag as the base ref.
48+
- Choose the newly created minor release branch as the head ref.
49+
50+
And then you can get all relevant changes between the two branches.
51+
![img](../resources/developers/release-compare.png)
52+
53+
Then extract the preceding types of release notes from these changes. For example, extract [this](https://github.com/karmada-io/karmada/pull/2675) as:
4454
```text
4555
## Bug Fixes
4656
* `karmada-controller-manager`: Fixed the panic when cluster ImpersonatorSecretRef is nil.
93.6 KB
Loading

i18n/zh/docusaurus-plugin-content-docs/current/developers/releasing.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,18 @@ Minor版本应该从对于的minor分支发布,发布步骤描述如下。
3939
### Instrumentation
4040
* 可观测性相关更新,例如,增加监控数据/事件记录。此部分内容需要手动整理收集。
4141
```
42-
为了获取如上所有相关内容,需要对比新创建的minor release分支和上一版本的minor release tag,例如,比较`release-1.4`分支和`v1.3.0`tag。然后从这些对比修改中提取为如上不同类型的发布说明。例如,从[此修改](https://github.com/karmada-io/karmada/pull/2675)提取如下发布说明:
42+
#### 收集发布说明(手动)
43+
44+
为了获取如上所有相关内容,需要对比新创建的 minor release分支和此版本的 minor pre-release tag,例如,比较 `release-1.8`分支和 `v1.8.0-alpha.0`tag。以下是在 GitHub中的操作步骤:
45+
46+
- 进入[Compare](https://github.com/karmada-io/karmada/compare)界面。
47+
- 选择 minor pre-release tag为基准分支。
48+
- 选择新创建的 minor release分支做为头分支。
49+
50+
界面就会显示两个分支间的所有相关内容。
51+
![img](../resources/developers/release-compare.png)
52+
53+
然后从这些对比修改中提取为如上不同类型的发布说明。例如,从[此修改](https://github.com/karmada-io/karmada/pull/2675)提取如下发布说明:
4354
```text
4455
## Bug Fixes
4556
* `karmada-controller-manager`: Fixed the panic when cluster ImpersonatorSecretRef is nil.
@@ -66,7 +77,7 @@ Users whose commits are in this release (alphabetically by username)
6677
安装`Karmada`时,对应镜像需要从DockerHub/SWR拉取,所以我们需要更新描述文件中的镜像tag为最新的minor版本。如下文件需要更新:
6778
* `charts/karmada/values.yaml`: 更新 `Karmada` 相关的镜像tag为即将发布的版本。
6879
* `charts/index.yaml`: 增加对应版本的helm仓库索引。
69-
80+
7081
### 添加升级文档(手动)
7182
新minor版本发布时,对应升级文档`docs/administrator/upgrading/v{major}.{minor_previous}-v{major}.{minor_new}.md`需要被添加到 [website](https://github.com/karmada-io/website) 仓库。例如,发布minor版本`v1.4.0`时,需要添加升级文档`docs/administrator/upgrading/v1.3-v1.4.md`
7283

Loading

0 commit comments

Comments
 (0)