Browse Source

[doc] Change release process base on new tool (#12324)

ref: #11478 we already have a new tool for releasing
3.2.0-release
Jiajie Zhong 2 years ago committed by GitHub
parent
commit
501119bbb6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 3
      docs/docs/en/contribute/release/release-post.md
  2. 6
      docs/docs/en/contribute/release/release.md
  3. 3
      docs/docs/zh/contribute/release/release-post.md
  4. 9
      docs/docs/zh/contribute/release/release.md

3
docs/docs/en/contribute/release/release-post.md

@ -28,5 +28,4 @@ to finish PyPI release.
## Get All Contributors ## Get All Contributors
You might need all contributors in current release when you want to publish the release news or announcement, you could You might need all contributors in current release when you want to publish the release news or announcement, you could
use the git command `git log --pretty="%an" <PREVIOUS-RELEASE-SHA>..<CURRENT-RELEASE-SHA> | sort | uniq` to auto generate use command `python release.py contributor` in directory `tools/release` to auto generate contributor GitHub id.
the git author name.

6
docs/docs/en/contribute/release/release.md

@ -389,8 +389,10 @@ to check the following items:
You should create a release note in GitHub by [new release note](https://github.com/apache/dolphinscheduler/releases/new). You should create a release note in GitHub by [new release note](https://github.com/apache/dolphinscheduler/releases/new).
It should be done before vote mail because we need the release note in the mail. You could use command It should be done before vote mail because we need the release note in the mail. You could use command
`git log --pretty="- %s" <PREVIOUS-RELEASE-SHA>..<CURRENT-RELEASE-SHA> > changelog.md` to creat the changelog(some log `python release.py changelog` in directory `tools/release` to creat the changelog.
maybe not correct, you should filter them by yourself) and classify them and paste them to GitHub release note page
> NOTE: Or if you prefer to create manually, you can use command `git log --pretty="- %s" <PREVIOUS-RELEASE-SHA>..<CURRENT-RELEASE-SHA> > changelog.md`
> (some log maybe not correct, you should filter them by yourself) and classify them and paste them to GitHub release note page
### Vote procedure ### Vote procedure

3
docs/docs/zh/contribute/release/release-post.md

@ -26,5 +26,4 @@
## 获取全部的贡献者 ## 获取全部的贡献者
当您想要发布新版本的新闻或公告时,您可能需要当前版本的所有贡献者,您可以使用 git 命令 `git log --pretty="%an" <PREVIOUS-RELEASE-SHA>..<CURRENT-RELEASE-SHA> | sort | uniq` 当您想要发布新版本的新闻或公告时,您可能需要当前版本的所有贡献者,您可以在 `tools/release` 中使用命令 `python release.py contributor` 自动生成贡献者 Github id。
(将对应的版本改成两个版本的 tag 值)自动生成 git 作者姓名。

9
docs/docs/zh/contribute/release/release.md

@ -353,7 +353,7 @@ gpg --verify apache_dolphinscheduler-python-"${VERSION}"-py3-none-any.whl.asc
cd ../ cd ../
``` ```
> 注意:当你找不到你的 `asc` 文件时,你必须手动创建 gpg 签名,命令 > 注意:当你找不到你的 `asc` 文件时,你必须手动创建 gpg 签名,命令
> `gpg --armor --detach-sign --digest-algo=SHA512 apache-dolphinscheduler-"${VERSION}"-bin.tar.gz` > `gpg --armor --detach-sign --digest-algo=SHA512 apache-dolphinscheduler-"${VERSION}"-bin.tar.gz`
> `gpg --armor --detach-sign --digest-algo=SHA512 apache-dolphinscheduler-"${VERSION}"-src.tar.gz` 将创建它们 > `gpg --armor --detach-sign --digest-algo=SHA512 apache-dolphinscheduler-"${VERSION}"-src.tar.gz` 将创建它们
@ -389,8 +389,11 @@ cd ../
### 更新版本说明 ### 更新版本说明
在 GitHub 中通过 [创建新的 release note](https://github.com/apache/dolphinscheduler/releases/new) 创建一个 release note。 这要在 在 GitHub 中通过 [创建新的 release note](https://github.com/apache/dolphinscheduler/releases/new) 创建一个 release note。 这要在
投票邮件开始之前完成,因为我们需要在邮件中使用 release note。你可以通过命令 `git log --pretty="- %s" <PREVIOUS-RELEASE-SHA>..<CURRENT-RELEASE-SHA> > changelog.md` 投票邮件开始之前完成,因为我们需要在邮件中使用 release note。你可以在 `tools/release` 目录中运行 `python release.py changelog` 自动创建
自动生成 changelog(部分可以不太准确,需要人为过滤一遍),然后将他们分类并粘贴到 GitHub 的 release note 中 changelog.
> 备注: 如果你更加倾向于手动创建 changelog,你可以通过命令 `git log --pretty="- %s" <PREVIOUS-RELEASE-SHA>..<CURRENT-RELEASE-SHA> > changelog.md`
> 生成 changelog(部分可以不太准确,需要人为过滤一遍),然后将他们分类并粘贴到 GitHub 的 release note 中
### 投票阶段 ### 投票阶段

Loading…
Cancel
Save