Skip to content

Commit

Permalink
Merge pull request #263 from casionone/dev
Browse files Browse the repository at this point in the history
update how-to-verify.md
  • Loading branch information
casionone authored May 23, 2022
2 parents 6525f2e + 88fccce commit 27ac748
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 12 deletions.
35 changes: 29 additions & 6 deletions community/how-to-verify.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -226,4 +239,14 @@ I checked:
3. LICENSE and NOTICE are exist
4. Build successfully on macOS(Big Sur)
5.  
````
````
## 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>
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 相关合规项检查
Expand Down Expand Up @@ -231,4 +247,14 @@ I checked:
3. LICENSE and NOTICE are exist
4. Build successfully on macOS(Big Sur)
5. ....
```
```
## 4. 注意事项
<font color="red">
如果你有安装maven工具,你可以使用自己的mvn命令替换 ./mvnw或则mvnw.cmd
mvnw是Maven Wrapper的缩写。它可以支持运行 Maven 项目,而无需安装 Maven 并配置环境变量。如果找不到它,它会根据配置文件,下载对应的 Maven 版本
</font>

0 comments on commit 27ac748

Please sign in to comment.