You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@linkis.apache.org by ca...@apache.org on 2022/05/23 03:00:16 UTC
[incubator-linkis-website] branch dev updated: update how-to-verify.md
This is an automated email from the ASF dual-hosted git repository.
casion 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 88fccce44 update how-to-verify.md
new 27ac748b0 Merge pull request #263 from casionone/dev
88fccce44 is described below
commit 88fccce44d9abb496d7d3cb6d59cc462edf54172
Author: casionone <ca...@gmail.com>
AuthorDate: Mon May 23 10:57:46 2022 +0800
update how-to-verify.md
---
community/how-to-verify.md | 35 ++++++++++++++++----
.../current/how-to-verify.md | 38 ++++++++++++++++++----
2 files changed, 61 insertions(+), 12 deletions(-)
diff --git a/community/how-to-verify.md b/community/how-to-verify.md
index aadc8ee2b..ec7f2c3d2 100644
--- a/community/how-to-verify.md
+++ b/community/how-to-verify.md
@@ -114,15 +114,21 @@ $ tar -xvf apache-linkis-${release_version}-incubating-src.tar.gz
$ cd apache-linkis-${release_version}-incubating-src
```
#### 2.4.1 ASF License RAT Check
-
+Mac OS/Linux
```shell
#normally can be executed within 5 minutes
-$ mvn -N install
-$ mvn apache-rat:check
+$ ./mvnw -N install
+$ ./mvnw apache-rat:check
#Check all rat files after no exception
$ find ./ -name rat.txt -print0 | xargs -0 -I file cat file > merged-rat.txt
```
+Window
+```shell
+#normally can be executed within 5 minutes
+$ mvnw.cmd -N install
+$ mvnw.cmd apache-rat:check
+````
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.
@@ -138,10 +144,17 @@ If it is not 0, you need to confirm whether the source code has the license for
#### 2.4.2 Source code compilation verification
+Mac OS/Linux
+```shell
+$ ./mvnw -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
+$ ./mvnw clean install -Dmaven.javadoc.skip=true -Dmaven.test.skip=true
+````
+Window
```shell
-$ mvn -N install
+$ mvnw.cmd -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
+$ mvnw.cmd clean install -Dmaven.javadoc.skip=true -Dmaven.test.skip=true
````
#### 2.4.3 Check related compliance items
@@ -226,4 +239,14 @@ I checked:
3. LICENSE and NOTICE are exist
4. Build successfully on macOS(Big Sur)
5.
-````
\ No newline at end of file
+````
+
+
+## 4. Precautions
+<font color="red">
+If you have maven tools installed, you can replace ./mvnw or mvnw.cmd with your own mvn command
+
+mvnw is short for Maven Wrapper. It can support running Maven projects without installing Maven and configuring environment variables. If it can't find it, it will download the corresponding Maven version according to the configuration file
+
+
+</font>
\ No newline at end of file
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 5934beb63..d3deecf35 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
@@ -112,15 +112,23 @@ $ cd apache-linkis-${release_version}-incubating-src
```
#### 2.4.1 ASF许可证RAT检查
-
+Mac OS/Linux
```shell
#正常5分钟内可以执行完
-$ mvn -N install
-$ mvn apache-rat:check
+$ ./mvnw -N install
+$ ./mvnw apache-rat:check
#无异常后 检查所有的rat文件
$ find ./ -name rat.txt -print0 | xargs -0 -I file cat file > merged-rat.txt
```
+
+Window
+```shell
+#正常5分钟内可以执行完
+$ mvnw.cmd -N install
+$ mvnw.cmd apache-rat:check
+```
+
rat check的白名单文件配置在外层pom.xml中的apache-rat-plugin插件配置中。
检查merged-rat.txt中所有license信息，注意Binaries 和Archives文件是否为0。
```text
@@ -135,10 +143,18 @@ Archives: 0
#### 2.4.2 源码编译验证
+Mac OS/Linux
```shell
-$ mvn -N install
+$ ./mvnw -N install
#如果编译所在的机器性能比较差，则此过程会比较耗时，一般耗时30min左右
-$ mvn clean install -Dmaven.javadoc.skip=true
+$ ./mvnw clean install -Dmaven.javadoc.skip=true -Dmaven.test.skip=true
+```
+
+Window
+```shell
+$ mvnw.cmd -N install
+#如果编译所在的机器性能比较差，则此过程会比较耗时，一般耗时30min左右
+$ mvnw.cmd clean install -Dmaven.javadoc.skip=true -Dmaven.test.skip=true
```
#### 2.4.3 相关合规项检查
@@ -231,4 +247,14 @@ I checked:
3. LICENSE and NOTICE are exist
4. Build successfully on macOS(Big Sur)
5. ....
-```
\ No newline at end of file
+```
+
+
+## 4. 注意事项
+<font color="red">
+如果你有安装maven工具，你可以使用自己的mvn命令替换 ./mvnw或则mvnw.cmd
+
+mvnw是Maven Wrapper的缩写。它可以支持运行 Maven 项目，而无需安装 Maven 并配置环境变量。如果找不到它，它会根据配置文件，下载对应的 Maven 版本
+
+
+</font>
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@linkis.apache.org
For additional commands, e-mail: commits-help@linkis.apache.org