This is an automated email from the ASF dual-hosted git repository.
peacewong pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-linkis-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 99052d3 update how-to-release.md
new 8bb1341 Merge pull request #124 from casionone/dev
99052d3 is described below
commit 99052d3838858263ae8a462b27c3577a1ebba43d
Author: casionone <[email protected]>
AuthorDate: Fri Jan 21 18:01:14 2022 +0800
update how-to-release.md
---
community/how-to-release.md | 144 ++++++++++-----------
community/how-to-verify.md | 101 ++++++++-------
.../current/how-to-release.md | 130 +++++++++----------
.../current/how-to-verify.md | 92 ++++++-------
4 files changed, 234 insertions(+), 233 deletions(-)
diff --git a/community/how-to-release.md b/community/how-to-release.md
index 997147a..51c9c81 100644
--- a/community/how-to-release.md
+++ b/community/how-to-release.md
@@ -29,7 +29,7 @@ Note: The commands of GnuPG 1.x version and 2.x version are
slightly different.
After installation, the gpg command is added to the system environment
variables and is available
```sh
#Check the version, it should be 2.x
-gpg --version
+$ gpg --version
```
### 1.2. Generate key with gpg
@@ -40,7 +40,7 @@ gpg --version
According to the prompt, generate the key
```shell
-C:\Users\xxx>gpg --full-gen-key
+$ gpg --full-gen-key
gpg (GnuPG) 2.2.28; Copyright (C) 2021 g10 Code GmbH
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
@@ -101,29 +101,28 @@ sub rsa4096 2021-11-10 [E]
### 1.3. Upload the generated key to the public server
```shell
-gpg --keyid-format SHORT --list-keys
+$ gpg --keyid-format SHORT --list-keys
pub rsa4096/584EE68E 2021-11-10 [SC] #584EE68E is the key id
E7A9B12D1AC2D8CF857AF5851AE82584584EE68E
uid [ultimate] mingXiao (test key for apache create at 20211110)
<[email protected]>
sub rsa4096/399AA54F 2021-11-10 [E]
# Send public key to keyserver via key id
-gpg --keyserver keyserver.ubuntu.com --send-key 584EE68E
+$ gpg --keyserver keyserver.ubuntu.com --send-key 584EE68E
# Among them, keyserver.ubuntu.com is the selected keyserver, it is
recommended to use this, because the Apache Nexus verification uses this
keyserver
```
### 1.4. Check whether the key is created successfully
Verify whether it is synchronized to the public network. It takes about a
minute to find out. If it is not successful, you can upload and retry several
times
```shell
-method one
-gpg --keyserver keyserver.ubuntu.com --recv-keys 584EE68E #584EE68E is the
corresponding key id
+# method one
+$ gpg --keyserver keyserver.ubuntu.com --recv-keys 584EE68E #584EE68E is the
corresponding key id
-D:\>gpg --keyserver keyserver.ubuntu.com --recv-keys 584EE68E
#Results are as follows
gpg: key 1AE82584584EE68E: "mingXiao (test key for apache create at 20211110)
<[email protected]>" not changed
gpg: Total number processed: 1
gpg: unchanged: 1
-Way two
+# method two
Go directly to https://keyserver.ubuntu.com/ and enter the username mingXiao
to search the query results
```
@@ -141,19 +140,19 @@ Go directly to https://keyserver.ubuntu.com/ and enter
the username mingXiao to
Used to release RC version
```shell
-mkdir -p linkis_svn/dev
-cd linkis_svn/dev
+$ mkdir -p linkis_svn/dev
+$ cd linkis_svn/dev
-svn co https://dist.apache.org/repos/dist/dev/incubator/linkis
+$ svn co https://dist.apache.org/repos/dist/dev/incubator/linkis
# This step is relatively slow, and all versions will be copied. If the
network is broken, use svn cleanup to delete the lock and re-execute it, and
the upload will be resumed.
-cd linkis_svn/dev/linkis
+$ cd linkis_svn/dev/linkis
# Append the KEY you generated to the file KEYS, it is best to check if it is
correct after appending
-(gpg --list-sigs [email protected] && gpg --export --armor
[email protected]) >> KEYS
+$ (gpg --list-sigs [email protected] && gpg --export --armor
[email protected]) >> KEYS
# If there is a KEYS file before, it is not needed
-svn add KEYS
+$ svn add KEYS
#Submit to SVN
-svn ci -m "add gpg key for YOUR_NAME"
+$ svn ci -m "add gpg key for YOUR_NAME"
```
#### 1.5.2 Add public key to KEYS in release branch
@@ -162,19 +161,19 @@ Used to release the official version
```shell
-mkdir -p linkis_svn/release
-cd linkis_svn/release
+$ mkdir -p linkis_svn/release
+$ cd linkis_svn/release
-svn co https://dist.apache.org/repos/dist/release/incubator/linkis
+$ svn co https://dist.apache.org/repos/dist/release/incubator/linkis
# This step is relatively slow, and all versions will be copied. If the
network is broken, use svn cleanup to delete the lock and re-execute it, and
the upload will be resumed.
-cd linkis
+$ cd linkis
# Append the KEY you generated to the file KEYS, it is best to check if it is
correct after appending
-(gpg --list-sigs [email protected] && gpg --export --armor
[email protected]) >> KEYS
+$ (gpg --list-sigs [email protected] && gpg --export --armor
[email protected]) >> KEYS
# If there is a KEYS file before, it is not needed
-svn add KEYS
+$ svn add KEYS
#Submit to SVN
-svn ci -m "add gpg key for YOUR_NAME"
+$ svn ci -m "add gpg key for YOUR_NAME"
```
@@ -240,21 +239,22 @@ Create a release based on the previous release-1.0.3-rc1
tag, and check `This is
If the version number is incorrect, you need to modify the version number to
-```
-mvn versions:set -DnewVersion=1.0.3
+```shell
+$ mvn versions:set -DnewVersion=1.0.3
+
Modify the configuration in pom.xml
<linkis.version>1.0.3</linkis.version>
```
Check whether the code is normal, including the version number, the
compilation is successful, the unit test is all successful, the RAT check is
successful, etc.
-```
+```shell
#build check
-mvn clean install -Dmaven.javadoc.skip=true
+$ mvn clean install -Dmaven.javadoc.skip=true
#RAT LICENSE check
#It can be executed within 5 minutes normally. If the execution has not ended
for a long time, please check whether additional files that need not be checked
have been added due to actions such as compiling.
-mvn apache-rat:check
+$ mvn apache-rat:check
#Check all rat files after no exception
-find ./ -name rat.txt -print0 | xargs -0 -I file cat file > merged-rat.txt
+$ find ./ -name rat.txt -print0 | xargs -0 -I file cat file > merged-rat.txt
````
If the check is abnormal, please check whether additional unnecessary files
have been added due to compilation and other actions, which can be removed.
@@ -275,7 +275,7 @@ If it is not 0, you need to confirm whether there is a
license for the binary or
### 2.3 Publish jar package to Apache Nexus repository
```shell
# Start to compile and upload, it takes about 1h40min
-mvn -DskipTests deploy -Prelease -Dmaven.javadoc.skip=true
+$ mvn -DskipTests deploy -Prelease -Dmaven.javadoc.skip=true
```
:::caution Note
@@ -290,19 +290,19 @@ Step 2.4-3.3 execute the command, merge it in the
release.sh script, or execute
### 2.4 Package source code
```shell
-mkdir -p dist/apache-linkis
+$ mkdir -p dist/apache-linkis
#based on the release-1.0.3-rc1 branch to package the source code tar.gz
material
#--prefix=apache-linkis-1.0.3-incubating-src/ Note that the `/` archive will
be in the apache-linkis-1.0.3-incubating-src folder after decompression
#A pax_global_header file will be generated to record the commitid
information. Without the --prefix, it will cause pax_global_header to be in the
same level directory as the source file after decompression
-git archive --format=tar.gz
--output="dist/apache-linkis/apache-linkis-1.0.3-incubating-src.tar.gz"
--prefix=apache-linkis-1.0.3-incubating-src/ release-1.0.3-rc1
+$ git archive --format=tar.gz
--output="dist/apache-linkis/apache-linkis-1.0.3-incubating-src.tar.gz"
--prefix=apache-linkis-1.0.3-incubating-src/ release-1.0.3-rc1
```
### 2.5 Copy binary files
After step 2.3 is executed, the binary file has been generated, located in
assembly-combined-package/target/apache-linkis-1.0.3-incubating-bin.tar.gz
```shell
-cp assembly-combined-package/target/apache-linkis-1.0.3-incubating-bin.tar.gz
dist/apache-linkis
+$ cp
assembly-combined-package/target/apache-linkis-1.0.3-incubating-bin.tar.gz
dist/apache-linkis
```
### 2.6 Package front-end management console
@@ -316,40 +316,40 @@ Download Node.js to the local and install it. Download
link: [http://nodejs.cn/d
#### 2.6.2 Install dependencies
Execute the following commands in the terminal command line:
-```
+```shell
#Enter the project WEB root directory
-cd incubator-linkis/web
+$ cd incubator-linkis/web
#Required dependencies for installation project
-npm install
+$ npm install
```
**This step only needs to be performed the first time you use it. **
-Notice:
-```
+**Notice:**
+```shell
1. An error is reported in the npm install step under Windows:
Error: Can't find Python executable "python", you can set the PYTHON env
variable
Install windows-build-tools (administrator rights)
-npm install --global --production windows-build-tools
-Install node-gyp
-npm install --global node-gyp
+$ npm install --global --production windows-build-tools
+$ Install node-gyp
+$ npm install --global node-gyp
2. If the compilation fails, please follow the steps below to clean up and
re-execute
#Enter the project working directory, delete node_modules
-rm -rf node_modules
+$ rm -rf node_modules
#Delete package-lock.json
-rm -rf package-lock.json
+$ rm -rf package-lock.json
#Clear npm cache
-npm cache clear --force
+$ npm cache clear --force
#Re-download dependencies
-npm install
+$ npm install
```
#### 2.6.3 Package console project
Execute the following instructions on the terminal command line to package the
project and generate a compressed deployment installation package.
Check web/package.json, web/.env files, and check whether the version number
of the front-end management console is correct.
-```
-npm run build
+```shell
+$ npm run build
```
After the above command is successfully executed, the front-end management
console installation package
`apache-linkis-${version}-incubating-web-bin.tar.gz` will be generated
@@ -357,23 +357,23 @@ After the above command is successfully executed, the
front-end management conso
After step 2.6.3 is executed, the front-end management console installation
package has been generated, located at
web/apache-linkis-1.0.3-incubating-web-bin.tar.gz
```shell
-cp web/apache-linkis-1.0.3-incubating-web-bin.tar.gz dist/apache-linkis
+$ cp web/apache-linkis-1.0.3-incubating-web-bin.tar.gz dist/apache-linkis
```
### 2.7 Sign the source package/binary package/sha512
```shell
-cd dist/apache-linkis
+$ cd dist/apache-linkis
-for i in *.tar.gz; do echo $i; gpg --armor --output $i.asc --detach-sig $i;
done # Calculate signature
+$ for i in *.tar.gz; do echo $i; gpg --armor --output $i.asc --detach-sig $i;
done # Calculate signature
-for i in *.tar.gz; do echo $i; sha512sum $i > $i.sha512 ; done # Calculate
SHA512
+$ for i in *.tar.gz; do echo $i; sha512sum $i > $i.sha512 ; done # Calculate
SHA512
```
### 2.8 Check whether the generated signature/sha512 is correct
Verify that the signature is correct as follows:
```shell
-cd dist/apache-linkis
-for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i; done
+$ cd dist/apache-linkis
+$ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i; done
```
If something like the following appears, the signature is correct. Keyword:
**`Good signature`**
@@ -386,8 +386,8 @@ If something like the following appears, the signature is
correct. Keyword: **`G
Verify that sha512 is correct as follows:
```shell
-cd dist/apache-linkis
-for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
+$ cd dist/apache-linkis
+$ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
```
@@ -405,7 +405,7 @@ The detailed verification process can be found in
[Verification Candidate Versio
Check out the Linkis distribution directory from the Apache SVN dev directory.
```shell
-svn co https://dist.apache.org/repos/dist/dev/incubator/linkis
dist/linkis_svn_dev
+$ svn co https://dist.apache.org/repos/dist/dev/incubator/linkis
dist/linkis_svn_dev
```
@@ -416,27 +416,27 @@ For example: 1.0.3-RC1 version is voted, if the vote is
passed without any probl
If there is a problem (when voting in the linkis/incubator community, voters
will strictly check various release requirements and compliance issues) and
need to be corrected. After the correction, the vote will be re-initiated. The
candidate version for the next vote is 1.0.3- RC2.
```shell
-mkdir -p dist/linkis_svn_dev/1.0.3-RC1
+$ mkdir -p dist/linkis_svn_dev/1.0.3-RC1
```
Add the source code package, binary package, and Linkis executable binary
package to the SVN working directory.
```shell
-cp -f dist/apache-linkis/* dist/linkis_svn_dev/1.0.3-RC1
+$ cp -f dist/apache-linkis/* dist/linkis_svn_dev/1.0.3-RC1
```
### 3.3 Submit Apache SVN
```shell
-cd dist/linkis_svn_dev/
+$ cd dist/linkis_svn_dev/
# Check svn status
-svn status
+$ svn status
# Add to svn version
-svn add 1.0.3-RC1
-svn status
+$ svn add 1.0.3-RC1
+$ svn status
# Submit to svn remote server
-svn commit -m "prepare for 1.0.3-RC1"
+$ svn commit -m "prepare for 1.0.3-RC1"
```
If Chinese garbled characters appear in the svn command, you can try to set
the encoding format (set the encoding format: export LANG=en_US.UTF-8).
@@ -636,12 +636,12 @@ On behalf of Apache Linkis(Incubating) community
Merge the changes from the `${release_version}-RC` branch to the `master`
branch, and delete the `${release_version}-RC` branch after the merge is
completed
```shell
-git checkout master
-git merge origin/${release_version}-RC
-git pull
-git push origin master
-git push --delete origin ${release_version}-RC
-git branch -d ${release_version}-RC
+$ git checkout master
+$ git merge origin/${release_version}-RC
+$ git pull
+$ git push origin master
+$ git push --delete origin ${release_version}-RC
+$ git branch -d ${release_version}-RC
```
### 6.2 Migrating source and binary packages
@@ -650,12 +650,12 @@ Move the source and binary packages from the `dev`
directory of svn to the `rele
```shell
#Mobile source package and binary package
-svn mv
https://dist.apache.org/repos/dist/dev/incubator/linkis/${release_version}-${rc_version}
https://dist.apache.org/repos/dist/release/incubator/ linkis/ -m "transfer
packages for ${release_version}-${rc_version}"
+$ svn mv
https://dist.apache.org/repos/dist/dev/incubator/linkis/${release_version}-${rc_version}
https://dist.apache.org/repos/dist/release/incubator/ linkis/ -m "transfer
packages for ${release_version}-${rc_version}"
# The following operations decide whether to update the key of the release
branch according to the actual situation
# Remove KEYS in the original release directory
-svn delete https://dist.apache.org/repos/dist/release/incubator/linkis/KEYS -m
"delete KEYS"
+$ svn delete https://dist.apache.org/repos/dist/release/incubator/linkis/KEYS
-m "delete KEYS"
#copy dev directory KEYS to release directory
-svn cp https://dist.apache.org/repos/dist/dev/incubator/linkis/KEYS
https://dist.apache.org/repos/dist/release/incubator/linkis/ -m "transfer KEYS
for ${release_version}-${rc_version}"
+$ svn cp https://dist.apache.org/repos/dist/dev/incubator/linkis/KEYS
https://dist.apache.org/repos/dist/release/incubator/linkis/ -m "transfer KEYS
for ${release_version}-${rc_version}"
```
### 6.3 Confirm whether the packages under dev and release are correct
@@ -664,7 +664,7 @@ svn cp
https://dist.apache.org/repos/dist/dev/incubator/linkis/KEYS https://dist
- Delete the release package of the previous version in the
[release](https://dist.apache.org/repos/dist/release/incubator/linkis/)
directory, these packages will be automatically saved in [here](https:/
/archive.apache.org/dist/incubator/linkis/)
```shell
-svn delete
https://dist.apache.org/repos/dist/release/incubator/linkis/${last_release_version}
-m "Delete ${last_release_version}"
+$ svn delete
https://dist.apache.org/repos/dist/release/incubator/linkis/${last_release_version}
-m "Delete ${last_release_version}"
```
### 6.4 Release version in Apache Staging repository
diff --git a/community/how-to-verify.md b/community/how-to-verify.md
index 010cd0a..3d6f2e0 100644
--- a/community/how-to-verify.md
+++ b/community/how-to-verify.md
@@ -15,9 +15,9 @@ If the network is poor, downloading may be time-consuming.
The download is compl
:::
```shell
#If there is svn locally, you can clone to the local
-svn co
https://dist.apache.org/repos/dist/dev/incubator/linkis/${release_version}-${rc_version}/
+$ svn co
https://dist.apache.org/repos/dist/dev/incubator/linkis/${release_version}-${rc_version}/
#or download the material file directly
-wget
https://dist.apache.org/repos/dist/dev/incubator/linkis/${release_version}-${rc_version}/xxx.xxx
+$ wget
https://dist.apache.org/repos/dist/dev/incubator/linkis/${release_version}-${rc_version}/xxx.xxx
```
## 2. Verify that the uploaded version is compliant
@@ -36,54 +36,54 @@ First import the publisher's public key. Import KEYS from
the svn repository to
#### 2.2.1 Import public key
```shell
-curl https://dist.apache.org/repos/dist/dev/incubator/linkis/KEYS> KEYS #
Download KEYS
-gpg --import KEYS # Import KEYS to local
+$ curl https://dist.apache.org/repos/dist/dev/incubator/linkis/KEYS> KEYS #
Download KEYS
+$ gpg --import KEYS # Import KEYS to local
```
#### 2.2.2 Trust the public key
> Trust the KEY used in this version
```shell
- gpg --edit-key xxxxxxxxxx #KEY user used in this version
- gpg (GnuPG) 2.2.21; Copyright (C) 2020 Free Software Foundation, Inc.
- This is free software: you are free to change and redistribute it.
- There is NO WARRANTY, to the extent permitted by law.
-
- Secret key is available.
- gpg> trust #trust
- Please decide how far you trust this user to correctly verify other users'
keys
- (by looking at passports, checking fingerprints from different sources,
etc.)
-
- 1 = I don't know or won't say
- 2 = I do NOT trust
- 3 = I trust marginally
- 4 = I trust fully
- 5 = I trust ultimately
- m = back to the main menu
-
- Your decision? 5 #choose 5
- Do you really want to set this key to ultimate trust? (y/N) y #choose y
-
- gpg>
+$ gpg --edit-key xxxxxxxxxx #KEY user used in this version
+gpg (GnuPG) 2.2.21; Copyright (C) 2020 Free Software Foundation, Inc.
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+
+Secret key is available.
+gpg> trust #trust
+Please decide how far you trust this user to correctly verify other users' keys
+(by looking at passports, checking fingerprints from different sources, etc.)
+
+ 1 = I don't know or won't say
+ 2 = I do NOT trust
+ 3 = I trust marginally
+ 4 = I trust fully
+ 5 = I trust ultimately
+ m = back to the main menu
+
+Your decision? 5 #choose 5
+Do you really want to set this key to ultimate trust? (y/N) y #choose y
+
+gpg>
```
#### 2.2.3 Use the following command to check the signature
```shell
- for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i; done
- #or
- gpg --verify apache-linkis-${release_version}-src.tar.gz.asc
apache-linkis-${release_version}-src.tar.gz
- # If you upload a binary package, you also need to check whether the
signature of the binary package is correct
- gpg --verify apache-linkis-${release_version}-bin.tar.gz.asc
apache-linkis-${release_version}-bin.tar.gz
+$ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i; done
+#or
+$ gpg --verify apache-linkis-${release_version}-src.tar.gz.asc
apache-linkis-${release_version}-src.tar.gz
+# If you upload a binary package, you also need to check whether the signature
of the binary package is correct
+$ gpg --verify apache-linkis-${release_version}-bin.tar.gz.asc
apache-linkis-${release_version}-bin.tar.gz
```
check result
> If something like the following appears, it means the signature is correct.
> Keyword: **`Good signature`**
```shell
- apache-linkis-xxx-incubating-src.tar.gz
- gpg: Signature made XXXX
- gpg: using RSA key XXXXX
- gpg: Good signature from "xxx @apache.org>"
+apache-linkis-xxx-incubating-src.tar.gz
+gpg: Signature made XXXX
+gpg: using RSA key XXXXX
+gpg: Good signature from "xxx @apache.org>"
```
### 2.3 Check sha512 hash
@@ -92,7 +92,7 @@ check result
> macOS/Linux
```shell
-for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
+$ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
```
@@ -100,7 +100,7 @@ for i in *.tar.gz; do echo $i; sha512sum --check
$i.sha512; done
> Windows
```shell
-certUtil -hashfile apache-linkis-${release_version}-incubating-xxx.tar.gz
SHA512
+$ certUtil -hashfile apache-linkis-${release_version}-incubating-xxx.tar.gz
SHA512
#Compare the output content with the content of the
apache-linkis-${release_version}-incubating-xxx.tar.gz.sha512 file
```
@@ -109,20 +109,21 @@ certUtil -hashfile
apache-linkis-${release_version}-incubating-xxx.tar.gz SHA512
Unzip `apache-linkis-${release_version}-incubating-src.tar.gz`
```text
-tar -xvf apache-linkis-${release_version}-incubating-src.tar.gz
+$ tar -xvf apache-linkis-${release_version}-incubating-src.tar.gz
-cd apache-linkis-${release_version}-incubating-src
+$ cd apache-linkis-${release_version}-incubating-src
```
#### 2.4.1 ASF License RAT Check
-````
+```shell
#normally can be executed within 5 minutes
-mvn -N install
-mvn apache-rat:check
+$ mvn -N install
+$ mvn apache-rat:check
#Check all rat files after no exception
-find ./ -name rat.txt -print0 | xargs -0 -I file cat file > merged-rat.txt
-````
+$ find ./ -name rat.txt -print0 | xargs -0 -I file cat file > merged-rat.txt
+```
+
The whitelist file of rat check is configured in the apache-rat-plugin plugin
configuration in the outer pom.xml.
Check all the license information in merged-rat.txt, and notice if the
Binaries and Archives files are 0.
````text
@@ -137,10 +138,10 @@ If it is not 0, you need to confirm whether the source
code has the license for
#### 2.4.2 Source code compilation verification
-```shell script
-mvn -N install
+```shell
+$ mvn -N install
#If the performance of the machine where the compilation is located is
relatively poor, this process will be time-consuming, usually about 30min
-mvn clean install -Dmaven.javadoc.skip=true
+$ mvn clean install -Dmaven.javadoc.skip=true
````
#### 2.4.3 Check related compliance items
@@ -162,10 +163,10 @@ and check as follows:
Unzip `apache-linkis-${release_version}-incubating-bin.tar.gz`
-```shell script
-mkdir apache-linkis-${release_version}-incubating-bin
-tar -xvf apache-linkis-${release_version}-incubating-bin.tar.gz -C
apache-linkis-${release_version}-incubating-bin
-cd apache-linkis-${release_version}-incubating-bin
+```shell
+$ mkdir apache-linkis-${release_version}-incubating-bin
+$ tar -xvf apache-linkis-${release_version}-incubating-bin.tar.gz -C
apache-linkis-${release_version}-incubating-bin
+$ cd apache-linkis-${release_version}-incubating-bin
```
and check as follows:
- [ ] Folder contains the word `incubating`
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-release.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-release.md
index d99e138..59f7a8a 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-release.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-release.md
@@ -44,7 +44,7 @@ gpg --version
根据提示，生成 key
```shell
-C:\Users\xxx>gpg --full-gen-key
+$ gpg --full-gen-key
gpg (GnuPG) 2.2.28; Copyright (C) 2021 g10 Code GmbH
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
@@ -105,23 +105,22 @@ sub rsa4096 2021-11-10 [E]
### 1.3 上传生成的key到公共服务器
```shell
-gpg --keyid-format SHORT --list-keys
+$ gpg --keyid-format SHORT --list-keys
pub rsa4096/584EE68E 2021-11-10 [SC] #584EE68E就是key id
E7A9B12D1AC2D8CF857AF5851AE82584584EE68E
uid [ultimate] mingXiao (test key for apache create at 20211110)
<[email protected]>
sub rsa4096/399AA54F 2021-11-10 [E]
# 通过key id发送public key到keyserver
-gpg --keyserver keyserver.ubuntu.com --send-key 584EE68E
+$ gpg --keyserver keyserver.ubuntu.com --send-key 584EE68E
# 其中，keyserver.ubuntu.com为挑选的keyserver，建议使用这个, 因为Apache Nexus校验时是使用的这个keyserver
```
### 1.4 查看key是否创建成功
验证是否同步到公网，大概需要一分钟才能查到,未成功可以进行上传重试几次
```shell
方式一
-gpg --keyserver keyserver.ubuntu.com --recv-keys 584EE68E #584EE68E是对应的key id
+$ gpg --keyserver keyserver.ubuntu.com --recv-keys 584EE68E #584EE68E是对应的key id
-D:\>gpg --keyserver keyserver.ubuntu.com --recv-keys 584EE68E
#结果如下
gpg: key 1AE82584584EE68E: "mingXiao (test key for apache create at 20211110)
<[email protected]>" not changed
gpg: Total number processed: 1
@@ -143,19 +142,19 @@ gpg: unchanged: 1
用于发布RC版本
```shell
-mkdir -p linkis_svn/dev
-cd linkis_svn/dev
+$ mkdir -p linkis_svn/dev
+$ cd linkis_svn/dev
-svn co https://dist.apache.org/repos/dist/dev/incubator/linkis
+$ svn co https://dist.apache.org/repos/dist/dev/incubator/linkis
# 这个步骤比较慢，会把所有版本都拷贝下来，如果网断了，用svn cleanup删掉锁，重新执行一下，会断点续传
-cd linkis_svn/dev/linkis
+$ cd linkis_svn/dev/linkis
# 追加你生成的KEY到文件KEYS中, 追加后最好检查一下是否正确
-(gpg --list-sigs [email protected] && gpg --export --armor
[email protected]) >> KEYS
+$ (gpg --list-sigs [email protected] && gpg --export --armor
[email protected]) >> KEYS
# 如果之前存在KEYS文件，则不需要
-svn add KEYS
+$ svn add KEYS
#提交到SVN
-svn ci -m "add gpg key for YOUR_NAME"
+$ svn ci -m "add gpg key for YOUR_NAME"
```
#### 1.5.2 在release分支中添加公钥到KEYS
@@ -163,20 +162,19 @@ svn ci -m "add gpg key for YOUR_NAME"
用于发布正式版本
```shell
+$ mkdir -p linkis_svn/release
+$ cd linkis_svn/release
-mkdir -p linkis_svn/release
-cd linkis_svn/release
-
-svn co https://dist.apache.org/repos/dist/release/incubator/linkis
+$ svn co https://dist.apache.org/repos/dist/release/incubator/linkis
# 这个步骤比较慢，会把所有版本都拷贝下来，如果网断了，用svn cleanup删掉锁，重新执行一下，会断点续传
-cd linkis
+$ cd linkis
# 追加你生成的KEY到文件KEYS中, 追加后最好检查一下是否正确
-(gpg --list-sigs [email protected] && gpg --export --armor
[email protected]) >> KEYS
+$ (gpg --list-sigs [email protected] && gpg --export --armor
[email protected]) >> KEYS
# 如果之前存在KEYS文件，则不需要
-svn add KEYS
+$ svn add KEYS
#提交到SVN
-svn ci -m "add gpg key for YOUR_NAME"
+$ svn ci -m "add gpg key for YOUR_NAME"
```
@@ -243,22 +241,22 @@ svn ci -m "add gpg key for YOUR_NAME"
如果版本号不正确，需要统一修改版本号为
-```
-mvn versions:set -DnewVersion=1.0.3
+```shell
+$ mvn versions:set -DnewVersion=1.0.3
#修改最外层pom.xml中的配置
<linkis.version>1.0.3</linkis.version>
```
检查代码是否正常，包括版本号，编译成功、单元测试全部成功，RAT检查成功等等
```
#build检查
-mvn clean install -Dmaven.javadoc.skip=true
+$ mvn clean install -Dmaven.javadoc.skip=true
#RAT LICENSE检查
#正常5分钟内可以执行完，如果长时间未执行结束，请检查是否由于编译等动作，增加了额外不必要检查的文件
-mvn apache-rat:check
+$ mvn apache-rat:check
#无异常后 检查所有的rat文件
-find ./ -name rat.txt -print0 | xargs -0 -I file cat file > merged-rat.txt
+$ find ./ -name rat.txt -print0 | xargs -0 -I file cat file > merged-rat.txt
```
若check异常，请检查是否由于编译等动作，增加了额外不必要检查的文件，可以移除掉。
rat check的白名单文件配置在外层pom.xml中的apache-rat-plugin插件配置中。
@@ -278,7 +276,7 @@ Archives: 0
### 2.3 发布jar包到Apache Nexus仓库
```shell
# 开始编译并上传 耗时大概在1h40min左右
-mvn -DskipTests deploy -Prelease -Dmaven.javadoc.skip=true
+$ mvn -DskipTests deploy -Prelease -Dmaven.javadoc.skip=true
```
:::caution 注意
出现下列情况，请先登陆https://repository.apache.org/#stagingRepositories
@@ -295,18 +293,18 @@ mvn -DskipTests deploy -Prelease -Dmaven.javadoc.skip=true
### 2.4 打包源码
```shell
-mkdir -p dist/apache-linkis
+$ mkdir -p dist/apache-linkis
#基于release-1.0.3-rc1分支打包源码的tar.gz物料
#--prefix=apache-linkis-1.0.3-incubating-src/ 注意带上`/`
压缩包解压后会是在apache-linkis-1.0.3-incubating-src文件夹中
#会生成一个pax_global_header文件 记录的是commitid信息，不加--prefix会导致解压后pax_global_header
和源码文件同级目录
-git archive --format=tar.gz
--output="dist/apache-linkis/apache-linkis-1.0.3-incubating-src.tar.gz"
--prefix=apache-linkis-1.0.3-incubating-src/ release-1.0.3-rc1
+$ git archive --format=tar.gz
--output="dist/apache-linkis/apache-linkis-1.0.3-incubating-src.tar.gz"
--prefix=apache-linkis-1.0.3-incubating-src/ release-1.0.3-rc1
```
### 2.5 拷贝二进制文件
步骤2.3执行后，二进制文件已经生成，位于assembly-combined-package/target/apache-linkis-1.0.3-incubating-bin.tar.gz
```shell
-cp assembly-combined-package/target/apache-linkis-1.0.3-incubating-bin.tar.gz
dist/apache-linkis
+$ cp
assembly-combined-package/target/apache-linkis-1.0.3-incubating-bin.tar.gz
dist/apache-linkis
```
### 2.6 打包前端管理台(如果需要发布前端)
@@ -322,9 +320,9 @@ cp
assembly-combined-package/target/apache-linkis-1.0.3-incubating-bin.tar.gz
在终端命令行中执行以下指令：
```
#进入项目WEB根目录
-cd incubator-linkis/web
+$ cd incubator-linkis/web
#安装项目所需依赖
-npm install
+$ npm install
```
**该步骤仅第一次使用时需要执行。**
@@ -332,29 +330,29 @@ npm install
在终端命令行执行以下指令对项目进行打包，生成压缩后的部署安装包。
检查web/package.json，web/.env文件，检查前端管理台版本号是否正确。
```
-npm run build
+$ npm run build
```
上述命令执行成功后，会生成前端管理台安装包 `apache-linkis-${version}-incubating-web-bin.tar.gz`
注意：
-```
+```shell
1.Windows下npm install 步骤报错：
Error: Can't find Python executable "python", you can set the PYTHON env
variable
安装windows-build-tools （管理员权限）
-npm install --global --production windows-build-tools
+$ npm install --global --production windows-build-tools
安装node-gyp
-npm install --global node-gyp
+$ npm install --global node-gyp
2.如果编译失败 请按如下步骤清理后重新执行
#进入项目工作目录，删除 node_modules
-rm -rf node_modules
+$ rm -rf node_modules
#删除 package-lock.json
-rm -rf package-lock.json
+$ rm -rf package-lock.json
#清除 npm 缓存
-npm cache clear --force
+$ npm cache clear --force
#重新下载依赖
-npm install
+$ npm install
```
@@ -362,22 +360,22 @@ npm install
步骤2.6.3执行后，前端管理台安装包已经生成，位于 web/apache-linkis-1.0.3-incubating-web-bin.tar.gz
```shell
-cp web/apache-linkis-1.0.3-incubating-web-bin.tar.gz dist/apache-linkis
+$ cp web/apache-linkis-1.0.3-incubating-web-bin.tar.gz dist/apache-linkis
```
### 2.7 对源码包/二进制包进行签名/sha512
```shell
-cd dist/apache-linkis
-for i in *.tar.gz; do echo $i; gpg --armor --output $i.asc --detach-sig $i ;
done # 计算签名
+$ cd dist/apache-linkis
+$ for i in *.tar.gz; do echo $i; gpg --armor --output $i.asc --detach-sig $i ;
done # 计算签名
-for i in *.tar.gz; do echo $i; sha512sum $i > $i.sha512 ; done # 计算SHA512
+$ for i in *.tar.gz; do echo $i; sha512sum $i > $i.sha512 ; done # 计算SHA512
```
### 2.8 检查生成的签名/sha512是否正确
验证签名是否正确如下：
```shell
-cd dist/apache-linkis
-for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done
+$ cd dist/apache-linkis
+$ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done
```
出现类似以下内容则说明签名正确，关键字：**`Good signature`**
```shell
@@ -389,8 +387,8 @@ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done
验证sha512是否正确如下：
```shell
-cd dist/apache-linkis
-for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
+$ cd dist/apache-linkis
+$ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
```
@@ -409,7 +407,7 @@ for i in *.tar.gz; do echo $i; sha512sum --check
$i.sha512; done
从Apache SVN dev目录检出Linkis发布目录。
```shell
-svn co https://dist.apache.org/repos/dist/dev/incubator/linkis
dist/linkis_svn_dev
+$ svn co https://dist.apache.org/repos/dist/dev/incubator/linkis
dist/linkis_svn_dev
```
@@ -420,27 +418,27 @@ svn co
https://dist.apache.org/repos/dist/dev/incubator/linkis dist/linkis_svn_
若存在问题（linkis/incubator社区投票时，投票者会严格检查各种发布要求项以及合规问题），需要修正，则修正后，再重新发起投票，下次投票的候选版本为1.0.3-RC2。
```shell
-mkdir -p dist/linkis_svn_dev/1.0.3-RC1
+$ mkdir -p dist/linkis_svn_dev/1.0.3-RC1
```
将源码包、二进制包和Linkis可执行二进制包添加至SVN工作目录。
```shell
-cp -f dist/apache-linkis/* dist/linkis_svn_dev/1.0.3-RC1
+$ cp -f dist/apache-linkis/* dist/linkis_svn_dev/1.0.3-RC1
```
### 3.3 提交Apache SVN
```shell
-cd dist/linkis_svn_dev/
+$ cd dist/linkis_svn_dev/
# 检查svn状态
-svn status
+$ svn status
# 添加到svn版本
-svn add 1.0.3-RC1
-svn status
+$ svn add 1.0.3-RC1
+$ status
#提交至svn远程服务器
-svn commit -m "prepare for 1.0.3-RC1"
+$ svn commit -m "prepare for 1.0.3-RC1"
```
若svn命令出现中文乱码，可尝试设置编码格式(设置编码格式:export LANG=en_US.UTF-8)。
@@ -651,12 +649,12 @@ On behalf of Apache Linkis(Incubating) community
合并`${release_version}-RC`分支的改动到`master`分支，合并完成后删除`${release_version}-RC`分支
```shell
-git checkout master
-git merge origin/${release_version}-RC
-git pull
-git push origin master
-git push --delete origin ${release_version}-RC
-git branch -d ${release_version}-RC
+$ git checkout master
+$ git merge origin/${release_version}-RC
+$ git pull
+$ git push origin master
+$ git push --delete origin ${release_version}-RC
+$ git branch -d ${release_version}-RC
```
### 6.2 迁移源码与二进制包
@@ -665,12 +663,14 @@ git branch -d ${release_version}-RC
```shell
#移动源码包与二进制包
-svn mv
https://dist.apache.org/repos/dist/dev/incubator/linkis/${release_version}-${rc_version}
https://dist.apache.org/repos/dist/release/incubator/linkis/ -m "transfer
packages for ${release_version}-${rc_version}"
+$ svn mv
https://dist.apache.org/repos/dist/dev/incubator/linkis/${release_version}-${rc_version}
https://dist.apache.org/repos/dist/release/incubator/linkis/ -m "transfer
packages for ${release_version}-${rc_version}"
+
# 下面操作 按实际情况 决定是否更新release 分支的key
# 清除原有release目录下的KEYS
-svn delete https://dist.apache.org/repos/dist/release/incubator/linkis/KEYS -m
"delete KEYS"
+$ svn delete https://dist.apache.org/repos/dist/release/incubator/linkis/KEYS
-m "delete KEYS"
+
# 拷贝dev目录KEYS到release目录
-svn cp https://dist.apache.org/repos/dist/dev/incubator/linkis/KEYS
https://dist.apache.org/repos/dist/release/incubator/linkis/ -m "transfer KEYS
for ${release_version}-${rc_version}"
+$ svn cp https://dist.apache.org/repos/dist/dev/incubator/linkis/KEYS
https://dist.apache.org/repos/dist/release/incubator/linkis/ -m "transfer KEYS
for ${release_version}-${rc_version}"
```
### 6.3 确认dev和release下的包是否正确
@@ -679,7 +679,7 @@ svn cp
https://dist.apache.org/repos/dist/dev/incubator/linkis/KEYS https://dist
- 删除[release](https://dist.apache.org/repos/dist/release/incubator/linkis/)目录下
上一个版本的发布包，这些包会被自动保存在[这里](https://archive.apache.org/dist/incubator/linkis/)
```shell
-svn delete
https://dist.apache.org/repos/dist/release/incubator/linkis/${last_release_version}
-m "Delete ${last_release_version}"
+$ svn delete
https://dist.apache.org/repos/dist/release/incubator/linkis/${last_release_version}
-m "Delete ${last_release_version}"
```
### 6.4 在Apache Staging仓库发布版本
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-verify.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-verify.md
index 0da6535..96bc7c4 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-verify.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-verify.md
@@ -34,54 +34,54 @@ wget
https://dist.apache.org/repos/dist/dev/incubator/linkis/${release_version}-
#### 2.2.1 导入公钥
```shell
-curl https://dist.apache.org/repos/dist/dev/incubator/linkis/KEYS > KEYS #
下载KEYS
-gpg --import KEYS # 导入KEYS到本地
+$ curl https://dist.apache.org/repos/dist/dev/incubator/linkis/KEYS > KEYS #
下载KEYS
+$ gpg --import KEYS # 导入KEYS到本地
```
#### 2.2.2 信任公钥
> 信任此次版本所使用的KEY
```shell
- gpg --edit-key xxxxxxxxxx #此次版本所使用的KEY用户
- gpg (GnuPG) 2.2.21; Copyright (C) 2020 Free Software Foundation, Inc.
- This is free software: you are free to change and redistribute it.
- There is NO WARRANTY, to the extent permitted by law.
-
- Secret key is available.
- gpg> trust #信任
- Please decide how far you trust this user to correctly verify other users'
keys
- (by looking at passports, checking fingerprints from different sources,
etc.)
-
- 1 = I don't know or won't say
- 2 = I do NOT trust
- 3 = I trust marginally
- 4 = I trust fully
- 5 = I trust ultimately
- m = back to the main menu
-
- Your decision? 5 #选择5
- Do you really want to set this key to ultimate trust? (y/N) y #选择y
-
- gpg>
-
+$ gpg --edit-key xxxxxxxxxx #此次版本所使用的KEY用户
+gpg (GnuPG) 2.2.21; Copyright (C) 2020 Free Software Foundation, Inc.
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+
+Secret key is available.
+gpg> trust #信任
+Please decide how far you trust this user to correctly verify other users' keys
+(by looking at passports, checking fingerprints from different sources, etc.)
+
+ 1 = I don't know or won't say
+ 2 = I do NOT trust
+ 3 = I trust marginally
+ 4 = I trust fully
+ 5 = I trust ultimately
+ m = back to the main menu
+
+Your decision? 5 #选择5
+Do you really want to set this key to ultimate trust? (y/N) y #选择y
+
+gpg>
+
```
#### 2.2.3 使用如下命令检查签名
```shell
- for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done
+$ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done
#或者
- gpg --verify apache-linkis-${release_version}-src.tar.gz.asc
apache-linkis-${release_version}-src.tar.gz
+$ gpg --verify apache-linkis-${release_version}-src.tar.gz.asc
apache-linkis-${release_version}-src.tar.gz
# 如果上传二进制包，则同样需要检查二进制包的签名是否正确
- gpg --verify apache-linkis-${release_version}-bin.tar.gz.asc
apache-linkis-${release_version}-bin.tar.gz
+$ gpg --verify apache-linkis-${release_version}-bin.tar.gz.asc
apache-linkis-${release_version}-bin.tar.gz
```
检查结果
> 出现类似以下内容则说明签名正确，关键字：**`Good signature`**
```shell
- apache-linkis-xxx-incubating-src.tar.gz
- gpg: Signature made XXXX
- gpg: using RSA key XXXXX
- gpg: Good signature from "xxx @apache.org>"
+apache-linkis-xxx-incubating-src.tar.gz
+gpg: Signature made XXXX
+gpg: using RSA key XXXXX
+gpg: Good signature from "xxx @apache.org>"
```
### 2.3 检查sha512哈希
@@ -90,14 +90,14 @@ gpg --import KEYS # 导入KEYS到本地
> Mac OS/Linux
```shell
-for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
+$ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
```
> Windows
```shell
-certUtil -hashfile apache-linkis-${release_version}-incubating-xxx.tar.gz
SHA512
+$ certUtil -hashfile apache-linkis-${release_version}-incubating-xxx.tar.gz
SHA512
#并将输出内容与 apache-linkis-${release_version}-incubating-xxx.tar.gz.sha512文件内容作对比
```
@@ -106,20 +106,20 @@ certUtil -hashfile
apache-linkis-${release_version}-incubating-xxx.tar.gz SHA512
解压缩`apache-linkis-${release_version}-incubating-src.tar.gz`
```text
-tar -xvf apache-linkis-${release_version}-incubating-src.tar.gz
+$ tar -xvf apache-linkis-${release_version}-incubating-src.tar.gz
-cd apache-linkis-${release_version}-incubating-src
+$ cd apache-linkis-${release_version}-incubating-src
```
#### 2.4.1 ASF许可证RAT检查
-```
+```shell
#正常5分钟内可以执行完
-mvn -N install
-mvn apache-rat:check
+$ mvn -N install
+$ mvn apache-rat:check
#无异常后 检查所有的rat文件
-find ./ -name rat.txt -print0 | xargs -0 -I file cat file > merged-rat.txt
+$ find ./ -name rat.txt -print0 | xargs -0 -I file cat file > merged-rat.txt
```
rat check的白名单文件配置在外层pom.xml中的apache-rat-plugin插件配置中。
检查merged-rat.txt中所有license信息，注意Binaries 和Archives文件是否为0。
@@ -135,10 +135,10 @@ Archives: 0
#### 2.4.2 源码编译验证
-```shell script
-mvn -N install
+```shell
+$ mvn -N install
#如果编译所在的机器性能比较差，则此过程会比较耗时，一般耗时30min左右
-mvn clean install -Dmaven.javadoc.skip=true
+$ mvn clean install -Dmaven.javadoc.skip=true
```
#### 2.4.3 相关合规项检查
@@ -161,11 +161,11 @@ mvn clean install -Dmaven.javadoc.skip=true
解压缩`apache-linkis-${release_version}-incubating-bin.tar.gz`，
-```shell script
+```shell
-mkdir apache-linkis-${release_version}-incubating-bin
-tar -xvf apache-linkis-${release_version}-incubating-bin.tar.gz -C
apache-linkis-${release_version}-incubating-bin
-cd apache-linkis-${release_version}-incubating-bin
+$ mkdir apache-linkis-${release_version}-incubating-bin
+$ tar -xvf apache-linkis-${release_version}-incubating-bin.tar.gz -C
apache-linkis-${release_version}-incubating-bin
+$ cd apache-linkis-${release_version}-incubating-bin
```
进行如下检查：
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
