chore: improve license header checker confs and pre-check header when…

… validating (#2445) * improve license header checker confs * typo * verify -> validate * update rat exclude files * empty commit * update rat exclude files * update rat exclude files
apache · Feb 23, 2024 · bc421bb · bc421bb
1 parent f6da2ee
commit bc421bb
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 19 deletions.
diff --git a/.github/workflows/licence-checker.yml b/.github/workflows/licence-checker.yml
@@ -24,7 +24,7 @@ jobs:
           token: ${{ github.token }}
           config: .licenserc.yaml
 
-      - name: License check(RAT)
+      - name: License Check (RAT)
         run: |
           mvn apache-rat:check -ntp
           find ./ -name rat.txt -print0 | xargs -0 -I file cat file > merged-rat.txt

diff --git a/.licenserc.yaml b/.licenserc.yaml
@@ -26,28 +26,30 @@ header: # `header` section is configurations for source codes license header.
       The ASF licenses this file to You under the Apache License, Version 2.0
       (the "License"); you may not use this file except in compliance with
       the License.  You may obtain a copy of the License at
+
           http://www.apache.org/licenses/LICENSE-2.0
+
       Unless required by applicable law or agreed to in writing, software
       distributed under the License is distributed on an "AS IS" BASIS,
       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
       See the License for the specific language governing permissions and
       limitations under the License.
     # `pattern` is optional regexp if all the file headers are the same as `license` or the license of `spdx-id` and `copyright-owner`.
     pattern: |
-      Licensed to the Apache Software Foundation under one or more contributor
-      license agreements. See the NOTICE file distributed with
-      this work for additional information regarding copyright
-      ownership. The Apache Software Foundation licenses this file to you under
-      the Apache License, Version 2.0 \(the "License"\); you may
-      not use this file except in compliance with the License.
-      You may obtain a copy of the License at
+      Licensed to the Apache Software Foundation \(ASF\) under one or more
+      contributor license agreements.  See the NOTICE file distributed with
+      this work for additional information regarding copyright ownership.
+      The ASF licenses this file to You under the Apache License, Version 2.0
+      \(the "License"\); you may not use this file except in compliance with
+      the License.  You may obtain a copy of the License at
+
           http://www.apache.org/licenses/LICENSE-2.0
-      Unless required by applicable law or agreed to in writing,
-      software distributed under the License is distributed on an
-      "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-      KIND, either express or implied.  See the License for the
-      specific language governing permissions and limitations
-      under the License.
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      See the License for the specific language governing permissions and
+      limitations under the License.
   paths: # `paths` are the path list that will be checked (and fixed) by license-eye, default is ['**'].
     - '**'
 
@@ -90,10 +92,11 @@ header: # `header` section is configurations for source codes license header.
     - '.repository/**'
     - '**/.flattened-pom.xml'
     - 'hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/backend/id/SnowflakeIdGenerator.java'
-    - '**/optimize/HugeScriptTraversal.java'
-    - '**/type/Nameable.java'
-    - '**/define/Cardinality.java'
-    - '**/util/StringEncoding.java'
+    - 'hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/traversal/optimize/HugeScriptTraversal.java'
+    - 'hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/type/Nameable.java'
+    - 'hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/type/define/Cardinality.java'
+    - 'hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/util/StringEncoding.java'
+    - 'hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/tinkerpop/ProcessBasicSuite.java'
     - 'hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/opencypher/CypherOpProcessor.java'
     - 'hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/opencypher/CypherPlugin.java'
   comment: on-failure # on what condition license-eye will comment on the pull request, `on-failure`, `always`, `never`.

diff --git a/pom.xml b/pom.xml
@@ -149,7 +149,7 @@
                             <exclude>**/*.map</exclude>
                             <exclude>**/*.properties</exclude>
                             <exclude>dist/**/*</exclude>
-                            <exclude>**/assembly/static/bin/hugegraph.service</exclude>
+                            <exclude>**/bin/hugegraph.service</exclude>
                             <exclude>**/swagger-ui/**/*</exclude>
                             <exclude>scripts/dev/reviewers</exclude>
                             <exclude>scripts/dev/reviewers</exclude>
@@ -175,6 +175,11 @@
                             <!-- Maven -->
                             <exclude>.repository/**</exclude>
                             <exclude>**/.flattened-pom.xml</exclude>
+                            <!-- Test generated data -->
+                            <exclude>**/rocksdb-*/**</exclude>
+                            <exclude>**/hbase-*/**</exclude>
+                            <exclude>**/apache-cassandra-*/**</exclude>
+                            <exclude>**/pid</exclude>
                         </excludes>
                         <consoleOutput>true</consoleOutput>
                     </configuration>
@@ -207,6 +212,21 @@
                 </plugin>
             </plugins>
         </pluginManagement>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.rat</groupId>
+                <artifactId>apache-rat-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>license-check</id>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                        <phase>validate</phase>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
     </build>
 
     <profiles>