Merge pull request #2067 from adafruit/spdx-test

Testing CI check

Author: TheKitty

.github/workflows/githubci.yml

@@ -3,6 +3,18 @@ name: Arduino Library CI
 on: [pull_request, push, repository_dispatch]
 
 jobs:
+  spdx:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/setup-python@v2
+      with:
+        python-version: "3.x"
+    - name: Checkout Current Repo
+      uses: actions/checkout@v2
+
+    - name: check SPDX licensing
+      run: python ./SPDX.py
+
   arduino:
     strategy:
       fail-fast: false
@@ -40,6 +52,7 @@ jobs:
     - name: test platforms
       run: python3 ci/build_platform.py ${{ matrix.arduino-platform }}
 
+
     - name: Upload build artifacts
       uses: actions/upload-artifact@v2
       with:

Adafruit_ESP32_Arduino_Demos/streaming_mp3_player/arduino_secrets.h

@@ -1,2 +1,6 @@
+// SPDX-FileCopyrightText: 2019 Limor Fried for Adafruit Industries
+//
+// SPDX-License-Identifier: MIT
+
 #define SECRET_SSID "ssid"
 #define SECRET_PASS "password"

Adafruit_ESP32_Arduino_Demos/streaming_nativemp3_player/arduino_secrets.h

@@ -1,2 +1,6 @@
+// SPDX-FileCopyrightText: 2019 Limor Fried for Adafruit Industries
+//
+// SPDX-License-Identifier: MIT
+
 #define SECRET_SSID "ssid"
 #define SECRET_PASS "pass"

Adafruit_ESP32_Arduino_Demos/streaming_podcast_player/arduino_secrets.h

@@ -1,2 +1,6 @@
+// SPDX-FileCopyrightText: 2019 Limor Fried for Adafruit Industries
+//
+// SPDX-License-Identifier: MIT
+
 #define SECRET_SSID "ssid"
 #define SECRET_PASS "password"

CircuitPython_Hardware_SD_Cards/hello/code.py

@@ -1 +1,5 @@
+# SPDX-FileCopyrightText: 2018 Jerry Needell for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
 print('Hello, World!')

Getting_Started_With_Raspberry_Pi_Pico/variable/code.py

@@ -1,2 +1,6 @@
+# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
 """Example of assigning a variable."""
 user_name = input("What is your name? ")

NY_Tower_Light/lambda/paho/__init__.py

@@ -1 +1,5 @@
+# SPDX-FileCopyrightText: 2019 Anne Barela for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
 

NY_Tower_Light/lambda/paho/mqtt/__init__.py

@@ -1 +1,5 @@
+# SPDX-FileCopyrightText: 2019 Anne Barela for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
 __version__ = "1.1"

SPDX.py

@@ -0,0 +1,74 @@
+# SPDX-FileCopyrightText: 2022 Eva Herrada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+import os
+import sys
+
+print("Starting SPDX Check")
+
+# add user bin to path!
+BUILD_DIR = ''
+# add user bin to path!
+try:
+    # If we're on actions
+    BUILD_DIR = os.environ["GITHUB_WORKSPACE"]
+except KeyError:
+    try:
+        # If we're on travis
+        BUILD_DIR = os.environ["TRAVIS_BUILD_DIR"]
+    except KeyError:
+        # If we're running on local machine
+        BUILD_DIR = os.path.abspath(".")
+
+print(f"Running in {BUILD_DIR}")
+files = []
+missing_file = []
+
+fail = False
+
+for r, d, f in os.walk(BUILD_DIR):
+    for file in f:
+        if file.split('.')[-1] in ("py", "cpp", "ino", "h"):
+            files.append(os.path.join(r, file))
+
+for file in files:
+    with open(file, "r") as F:
+        lines = []
+        for line in F.readlines():
+            if line[0] != "#" and line[:2] != "//":
+                break
+            lines.append(line)
+        status = {"copyright": False,
+                  "license": False,
+                  "licensefile": False}
+        for line in lines:
+            if "SPDX-FileCopyrightText:" in line:
+                status["copyright"] = True
+            if "SPDX-License-Identifier:" in line:
+                license_name = line.split("SPDX-License-Identifier: ")[1][:-1]
+                status["license"] = True
+                if os.path.isfile(BUILD_DIR+f"/LICENSES/{license_name}.txt"):
+                    status["licensefile"] = True
+                elif license_name not in missing_file:
+                    missing_file.append(f"LICENSES/{license_name}.txt")
+
+        if not all(status.values()):
+            fail = True
+            print(f"{file} is missing SPDX")
+            continue
+        if not status["copyright"]:
+            fail = True
+            print(f"{file}: SPDX-FileCopyrightText line is missing")
+        if not status["license"]:
+            fail = True
+            print(f"{file}: SPDX-License-Identifier line is missing")
+        if not status["licensefile"] and status["license"]:
+            fail = True
+            print(f"{file}: {license_name}.txt is missing from LICENSES/")
+
+if fail:
+    if missing_file:
+        print("Missing files:", missing_file)
+    sys.exit(-1)
+sys.exit(0)

Trinkey_QT2040_Enviro_Gadget/circuitpython/boot.py

@@ -1,2 +1,6 @@
+# SPDX-FileCopyrightText: 2021 Carter Nelson for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
 import usb_cdc
 usb_cdc.enable(data=True)