Add github action to check license header and dependencies license (#66)

* feat(): add github action for license headers and license checker dev dependency

Signed-off-by: sBouzols <[email protected]>

.github/config/.licenserc.yaml

@@ -0,0 +1,26 @@
+header:
+  license:
+    spdx-id: MPL-2.0
+    pattern: |
+      Copyright copyright \d{4}, RTE \(http:\/\/www\.rte-france\.com\)
+      This Source Code Form is subject to the terms of the Mozilla Public
+      License, v\. 2\.0\. If a copy of the MPL was not distributed with this
+      file, You can obtain one at http:\/\/mozilla\.org\/MPL\/2\.0\/\.
+
+  paths-ignore:
+    - 'dist'
+    - 'licenses'
+    - '**/*.md'
+    - 'LICENSE'
+    - 'NOTICE'
+    - 'Dockerfile'
+    - '**/.*'
+    - '**/*.txt'
+    - '**/*.json'
+    - '**/*.yaml'
+    - '**/*.yml'
+    - '**/*.svg'
+    - '**/*.css'
+    - '**/*.conf'
+
+  comment: on-failure

.github/workflows/build.yml

@@ -3,6 +3,22 @@ name: CI
 on: [push]
 
 jobs:
+    license-headers:
+      name: Check licenses headers
+      runs-on: ubuntu-latest
+
+      steps:
+        - uses: actions/setup-node@v3
+        - name: Checkout sources
+          uses: actions/checkout@v2
+          with:
+              persist-credentials: false
+
+        - name: Check License Header (Check Mode)
+          uses: apache/skywalking-eyes/[email protected]
+          with:
+            config: .github/config/.licenserc.yaml
+
     build-and-deploy:
         runs-on: ubuntu-latest
 
@@ -19,6 +35,7 @@ jobs:
             - name: Install and Build
               run: |
                   npm install
+                  npm run licenses-check
                   npm run-script test
                   npm run-script build
 

README.md

@@ -11,3 +11,15 @@ Create a new view in study-server and replace `yyy` with the new token in rest a
 
 Files tsconfig.json and src/react-app-env.d.ts both results from create-react-app typescript template (version 5).
 Some property values have been changed to meet the project needs (ex: target, baseUrl, ...).
+
+#### License Headers and dependencies checking
+
+To check dependencies license compatibility with this project one locally, please run the following command :
+
+```
+npm run licenses-check
+```
+
+Notes : 
+* Check [license-checker-config.json](license-checker-config.json) for license white list and exclusion.
+If you need to update this list, please inform organization's owners.

license-checker-config.json

@@ -0,0 +1,21 @@
+{
+    "onlyAllow" : [
+        "MPL-2.0",
+        "MIT",
+        "BSD-3-Clause",
+        "BSD-2-Clause",
+        "0BSD",
+        "Apache-2.0",
+        "ISC",
+        "Apache-Style",
+        "CC-BY-3.0",
+        "CC-BY-4.0",
+        "CC0-1.0",
+        "MIT AND CC-BY-3.0",
+        "MIT OR CC0-1.0",
+        "Artistic-2.0",
+        "Python-2.0",
+        "Unlicense"
+    ],
+    "excludePackages": []
+}