You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by li...@apache.org on 2021/01/15 03:18:46 UTC

[incubator-dolphinscheduler] branch dev updated: chore: set up license-eye to check license headers (#4453)

This is an automated email from the ASF dual-hosted git repository.

lidongdai pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-dolphinscheduler.git


The following commit(s) were added to refs/heads/dev by this push:
     new a6becd8  chore: set up license-eye to check license headers (#4453)
a6becd8 is described below

commit a6becd8c264257256ad7865f082a6e8767725a55
Author: Zhenxu Ke <ke...@apache.org>
AuthorDate: Fri Jan 15 11:18:37 2021 +0800

    chore: set up license-eye to check license headers (#4453)
---
 .github/workflows/ci_backend.yml                   | 12 ++----
 .github/workflows/ci_e2e.yml                       | 10 ++---
 .github/workflows/ci_frontend.yml                  | 24 +-----------
 .github/workflows/ci_ut.yml                        | 22 +++++------
 .licenserc.yaml                                    | 43 +++++++++++++++++++++
 .../src/js/module/visibility/index.js              |  2 +-
 pom.xml                                            | 44 ----------------------
 7 files changed, 63 insertions(+), 94 deletions(-)

diff --git a/.github/workflows/ci_backend.yml b/.github/workflows/ci_backend.yml
index c24a3ec..7b245d7 100644
--- a/.github/workflows/ci_backend.yml
+++ b/.github/workflows/ci_backend.yml
@@ -46,18 +46,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      # In the checkout@v2, it doesn't support git submodule. Execute the commands manually.
-      - name: checkout submodules
-        shell: bash
-        run: |
-          git submodule sync --recursive
-          git -c protocol.version=2 submodule update --init --force --recursive --depth=1
+        with:
+          submodule: true
+      - name: Check License Header
+        uses: apache/skywalking-eyes@9bd5feb
       - name: Set up JDK 1.8
         uses: actions/setup-java@v1
         with:
           java-version: 1.8
-      - name: Check license
-        run: ./mvnw -B apache-rat:check
       - name: Compile
         run: mvn -B clean compile install -Prelease -Dmaven.test.skip=true
       - name: Check dependency license
diff --git a/.github/workflows/ci_e2e.yml b/.github/workflows/ci_e2e.yml
index 8070d7e..3e78105 100644
--- a/.github/workflows/ci_e2e.yml
+++ b/.github/workflows/ci_e2e.yml
@@ -30,12 +30,10 @@ jobs:
     steps:
 
       - uses: actions/checkout@v2
-      # In the checkout@v2, it doesn't support git submodule. Execute the commands manually.
-      - name: checkout submodules
-        shell: bash
-        run: |
-          git submodule sync --recursive
-          git -c protocol.version=2 submodule update --init --force --recursive --depth=1
+        with:
+          submodule: true
+      - name: Check License Header
+        uses: apache/skywalking-eyes@9bd5feb
       - uses: actions/cache@v1
         with:
           path: ~/.m2/repository
diff --git a/.github/workflows/ci_frontend.yml b/.github/workflows/ci_frontend.yml
index 1feaaba..afa0c8d 100644
--- a/.github/workflows/ci_frontend.yml
+++ b/.github/workflows/ci_frontend.yml
@@ -35,12 +35,8 @@ jobs:
         os: [ubuntu-latest, macos-latest]
     steps:
       - uses: actions/checkout@v2
-      # In the checkout@v2, it doesn't support git submodule. Execute the commands manually.
-      - name: checkout submodules
-        shell: bash
-        run: |
-          git submodule sync --recursive
-          git -c protocol.version=2 submodule update --init --force --recursive --depth=1
+        with:
+          submodule: true
       - name: Set up Node.js
         uses: actions/setup-node@v1
         with:
@@ -52,19 +48,3 @@ jobs:
           npm install
           npm run lint
           npm run build
-  License-check:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      # In the checkout@v2, it doesn't support git submodule. Execute the commands manually.
-      - name: checkout submodules
-        shell: bash
-        run: |
-          git submodule sync --recursive
-          git -c protocol.version=2 submodule update --init --force --recursive --depth=1
-      - name: Set up JDK 1.8
-        uses: actions/setup-java@v1
-        with:
-          java-version: 1.8
-      - name: Check
-        run: mvn -B apache-rat:check
\ No newline at end of file
diff --git a/.github/workflows/ci_ut.yml b/.github/workflows/ci_ut.yml
index 739c9be..09542d9 100644
--- a/.github/workflows/ci_ut.yml
+++ b/.github/workflows/ci_ut.yml
@@ -33,12 +33,12 @@ jobs:
     steps:
 
       - uses: actions/checkout@v2
-      # In the checkout@v2, it doesn't support git submodule. Execute the commands manually.
-      - name: checkout submodules
-        shell: bash
-        run: |
-          git submodule sync --recursive
-          git -c protocol.version=2 submodule update --init --force --recursive --depth=1
+        with:
+          submodule: true
+      - name: Check License Header
+        uses: apache/skywalking-eyes@9bd5feb
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Only enable review / suggestion here
       - uses: actions/cache@v1
         with:
           path: ~/.m2/repository
@@ -98,12 +98,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      # In the checkout@v2, it doesn't support git submodule. Execute the commands manually.
-      - name: checkout submodules
-        shell: bash
-        run: |
-          git submodule sync --recursive
-          git -c protocol.version=2 submodule update --init --force --recursive --depth=1
+        with:
+          submodule: true
       - name: check code style
         env:
           WORKDIR: ./
@@ -117,4 +113,4 @@ jobs:
                | /opt/reviewdog -f=checkstyle \
                     -reporter="${INPUT_REPORTER:-github-pr-check}" \
                     -filter-mode="${INPUT_FILTER_MODE:-added}" \
-                    -fail-on-error="${INPUT_FAIL_ON_ERROR:-false}"
\ No newline at end of file
+                    -fail-on-error="${INPUT_FAIL_ON_ERROR:-false}"
diff --git a/.licenserc.yaml b/.licenserc.yaml
new file mode 100644
index 0000000..ea6909e
--- /dev/null
+++ b/.licenserc.yaml
@@ -0,0 +1,43 @@
+# Licensed to 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. Apache Software Foundation (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.
+
+header:
+  license:
+    spdx-id: Apache-2.0
+    copyright-owner: Apache Software Foundation
+
+  paths-ignore:
+    - dist
+    - NOTICE
+    - LICENSE
+    - DISCLAIMER
+    - dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/utils/ScriptRunner.java
+    - mvnw.cmd
+    - sql/soft_version
+    - .mvn
+    - .gitattributes
+    - '**/licenses/**/LICENSE-*'
+    - '**/*.md'
+    - '**/*.json'
+    - '**/*.iml'
+    - '**/.babelrc'
+    - '**/.eslintignore'
+    - '**/.gitignore'
+    - '**/LICENSE'
+    - '**/NOTICE'
+
+  comment: on-failure
diff --git a/dolphinscheduler-ui/src/js/module/visibility/index.js b/dolphinscheduler-ui/src/js/module/visibility/index.js
index 666ffaa..c3b50c6 100644
--- a/dolphinscheduler-ui/src/js/module/visibility/index.js
+++ b/dolphinscheduler-ui/src/js/module/visibility/index.js
@@ -3,7 +3,7 @@
  * 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 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
diff --git a/pom.xml b/pom.xml
index 721cdc8..be9e85a 100644
--- a/pom.xml
+++ b/pom.xml
@@ -97,7 +97,6 @@
         <presto.jdbc.version>0.238.1</presto.jdbc.version>
         <spotbugs.version>3.1.12</spotbugs.version>
         <checkstyle.version>3.0.0</checkstyle.version>
-        <apache.rat.version>0.13</apache.rat.version>
         <zookeeper.version>3.4.14</zookeeper.version>
         <frontend-maven-plugin.version>1.6</frontend-maven-plugin.version>
         <maven-compiler-plugin.version>3.3</maven-compiler-plugin.version>
@@ -925,49 +924,6 @@
                 </executions>
             </plugin>
             <plugin>
-                <groupId>org.apache.rat</groupId>
-                <artifactId>apache-rat-plugin</artifactId>
-                <version>${apache.rat.version}</version>
-                <configuration>
-                    <excludeSubProjects>false</excludeSubProjects>
-                    <addDefaultLicenseMatchers>false</addDefaultLicenseMatchers>
-                    <licenses>
-                        <license implementation="org.apache.rat.analysis.license.SimplePatternBasedLicense">
-                            <licenseFamilyCategory>AL20</licenseFamilyCategory>
-                            <licenseFamilyName>Apache License, 2.0</licenseFamilyName>
-                            <patterns>
-                                <pattern>Licensed to the Apache Software Foundation (ASF)</pattern>
-                            </patterns>
-                        </license>
-                    </licenses>
-                    <licenseFamilies>
-                        <licenseFamily implementation="org.apache.rat.license.SimpleLicenseFamily">
-                            <familyName>Apache License, 2.0</familyName>
-                        </licenseFamily>
-                    </licenseFamilies>
-                    <excludes>
-                        <exclude>**/node_modules/**</exclude>
-                        <exclude>**/node/**</exclude>
-                        <exclude>**/dist/**</exclude>
-                        <exclude>**/licenses/**</exclude>
-                        <exclude>.github/**</exclude>
-                        <exclude>**/sql/soft_version</exclude>
-                        <exclude>**/common/utils/ScriptRunner.java</exclude>
-                        <exclude>**/*.json</exclude>
-                        <!-- document files -->
-                        <exclude>**/*.md</exclude>
-                        <excldue>**/*.MD</excldue>
-                        <exclude>**/*.txt</exclude>
-                        <exclude>**/docs/**</exclude>
-                        <exclude>**/*.babelrc</exclude>
-                        <exclude>**/*.eslint*</exclude>
-                        <exclude>**/.mvn/jvm.config</exclude>
-                        <exclude>**/.mvn/wrapper/**</exclude>
-                    </excludes>
-                    <consoleOutput>true</consoleOutput>
-                </configuration>
-            </plugin>
-            <plugin>
                 <groupId>com.github.spotbugs</groupId>
                 <artifactId>spotbugs-maven-plugin</artifactId>
                 <version>${spotbugs.version}</version>