natas_hw
/
dolphinscheduler0701
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[fix][doc] Correct release export key step (#12228) (#12751) 

Co-authored-by: Jiajie Zhong <zhongjiajie955@gmail.com>
This commit is contained in:
Eric Gao 2022-11-07 11:43:28 +08:00 committed by GitHub
parent 8c3c94218b
commit 24ab06c181
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/docs/en/contribute/release/release.md
View File

@ -245,15 +245,22 @@ svn --username="${A_USERNAME}" co https://dist.apache.org/repos/dist/dev/dolphin
cd ~/ds_svn/dev/dolphinscheduler
```
### Add gpg Public Key
### Export your new gpg KEYS to release(optional)
Only the account in its first deployment needs to add that.
It is alright for `KEYS` to only include the public key of the deployed account.
Only if the first time you release with this gpg KEY, including it is you first release, or you change your KEY. You should
change working directory to another one because this step need checkout and change KEYS in release directory.
```shell
mkdir -p ~/ds_svn/release/
cd ~/ds_svn/release/
svn --username="${A_USERNAME}" co https://dist.apache.org/repos/dist/release/dolphinscheduler
gpg -a --export <YOUR-GPG-KEY-ID> >> KEYS
svn add *
svn --username="${A_USERNAME}" commit -m "new key <YOUR-GPG-KEY-ID> add"
```
> NOTE: it may take a few minutes to sync to the mirror in your first time checkout, because it will download all the files
### Add the Release Content to SVN Directory
Create folder by version number.
@ -312,7 +319,7 @@ First, import releaser's public key.
Import KEYS from SVN repository to local. (The releaser does not need to import again; the checking assistant needs to import it, with the user name filled as the releaser's. )
```shell
curl https://dist.apache.org/repos/dist/dev/dolphinscheduler/KEYS >> KEYS
curl https://dist.apache.org/repos/dist/release/dolphinscheduler/KEYS >> KEYS
gpg --import KEYS
gpg --edit-key "${A_USERNAME}"
> trust
@ -419,7 +426,7 @@ Git tag for the release: https://github.com/apache/dolphinscheduler/tree/<VERSIO
Release Commit ID: https://github.com/apache/dolphinscheduler/commit/<SHA-VALUE>
Keys to verify the Release Candidate: https://dist.apache.org/repos/dist/dev/dolphinscheduler/KEYS
Keys to verify the Release Candidate: https://downloads.apache.org/dolphinscheduler/KEYS
Look at here for how to verify this release candidate: https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/contribute/release/release.html
@ -469,19 +476,6 @@ Thanks everyone for taking time to check this release and help us.
svn mv https://dist.apache.org/repos/dist/dev/dolphinscheduler/"${VERSION}" https://dist.apache.org/repos/dist/release/dolphinscheduler/
```
### Export you new gpg KEYS from dev to release(optional)
Only if the first time you release with this gpg KEY, including it is you first release or you change your KEY
```shell
mkdir -p ~/ds_svn/release/
cd ~/ds_svn/release/
svn --username="${A_USERNAME}" co https://dist.apache.org/repos/dist/release/dolphinscheduler
gpg -a --export <YOUR-GPG-KEY-ID> >> KEYS
svn add *
svn --username="${A_USERNAME}" commit -m "new key <YOUR-GPG-KEY-ID> add"
```
### Update Document
Website should be present before you send the announce mail this section will tell you how to change the website. For example,

29
docs/docs/zh/contribute/release/release.md
View File

@ -246,14 +246,22 @@ svn --username="${A_USERNAME}" co https://dist.apache.org/repos/dist/dev/dolphin
cd ~/ds_svn/dev/dolphinscheduler
```
### 添加gpg公钥
### 将 gpg KEYS 文件拷贝至发布目录（可选）
仅第一次部署的账号需要添加，只要`KEYS`中包含已经部署过的账户的公钥即可。
只有你第一次使用该 KEY 发版时才需要，如果之前已经发过版且 KEY 没有变化则不需要。你需要切换到一个新的目录，因为这步骤需要 checkout 并修改 release
库中的 KEYS 文件
```shell
mkdir -p ~/ds_svn/release/
cd ~/ds_svn/release/
svn --username="${A_USERNAME}" co https://dist.apache.org/repos/dist/release/dolphinscheduler
gpg -a --export <YOUR-GPG-KEY-ID> >> KEYS
svn add *
svn --username="${A_USERNAME}" commit -m "new key <YOUR-GPG-KEY-ID> add"
```
> 注意：这个步骤需要一定的时间去 checkout 特别是在你第一次 checkout 的时候，因为这个库比较大，且这个操作需要 checkout 出全部文件
### 将待发布的内容添加至SVN目录
创建版本号目录。
@ -311,7 +319,7 @@ cd ../
首先导入发布人公钥。从svn仓库导入KEYS到本地环境。（发布版本的人不需要再导入，帮助做验证的人需要导入，用户名填发版人的即可）
```shell
curl https://dist.apache.org/repos/dist/dev/dolphinscheduler/KEYS >> KEYS
curl https://dist.apache.org/repos/dist/release/dolphinscheduler/KEYS >> KEYS
gpg --import KEYS
gpg --edit-key "${A_USERNAME}"
> trust
@ -415,7 +423,7 @@ Git tag for the release: https://github.com/apache/dolphinscheduler/tree/<VERSIO
Release Commit ID: https://github.com/apache/dolphinscheduler/commit/<SHA-VALUE>
Keys to verify the Release Candidate: https://dist.apache.org/repos/dist/dev/dolphinscheduler/KEYS
Keys to verify the Release Candidate: https://downloads.apache.org/dolphinscheduler/KEYS
Look at here for how to verify this release candidate: https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/contribute/release/release.html
@ -466,19 +474,6 @@ Thanks everyone for taking time to check this release and help us.
svn mv https://dist.apache.org/repos/dist/dev/dolphinscheduler/"${VERSION}" https://dist.apache.org/repos/dist/release/dolphinscheduler/
```
### 将 gpg KEYS svn的dev目录移动到release目录
只有你第一次使用该 KEY 发版时才需要，如果之前已经发过版且 KEY 没有变化则不需要
```shell
mkdir -p ~/ds_svn/release/
cd ~/ds_svn/release/
svn --username="${A_USERNAME}" co https://dist.apache.org/repos/dist/release/dolphinscheduler
gpg -a --export <YOUR-GPG-KEY-ID> >> KEYS
svn add *
svn --username="${A_USERNAME}" commit -m "new key <YOUR-GPG-KEY-ID> add"
```
### 更新文档
官网应该在您发送通知邮件之前完成更新，本节将告诉您如何更改网站。假设发版的版本是 `<VERSION>`，需要进行以下更新（注意，当修改pull requests 被 merge 后就会生效）: